{ "openapi": "3.0.3", "info": { "title": "Bitrix24 REST API", "version": "1.0.0", "description": "Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com", "contact": { "name": "Bitrix24 Developer Support", "url": "https://apidocs.bitrix24.com/support.html" }, "license": { "name": "MIT", "url": "https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE" }, "x-logo": { "url": "https://apidocs.bitrix24.com/_images/bitrix24logo.svg" } }, "externalDocs": { "description": "Official Bitrix24 REST API Documentation", "url": "https://apidocs.bitrix24.com" }, "servers": [ { "url": "https://{portal}.bitrix24.com/rest", "description": "Your Bitrix24 portal (cloud)", "variables": { "portal": { "default": "your-portal", "description": "Subdomain of your Bitrix24 portal" } } }, { "url": "https://{host}/rest", "description": "On-Premise Bitrix24 installation", "variables": { "host": { "default": "your-bitrix24.example.com", "description": "Host of your on-premise installation" } } } ], "security": [ { "AccessToken": [] } ], "tags": [ { "name": "BIconnector" }, { "name": "Business Processes" }, { "name": "CRM" }, { "name": "Calendar" }, { "name": "Chatbots" }, { "name": "Chats" }, { "name": "CoPilot / AI" }, { "name": "Company Structure" }, { "name": "Data Storage" }, { "name": "Deprecated Methods" }, { "name": "Document Generator" }, { "name": "Drive" }, { "name": "E-Commerce" }, { "name": "Events" }, { "name": "General Methods" }, { "name": "Mail Services" }, { "name": "Message Providers" }, { "name": "News Feed" }, { "name": "Online Booking" }, { "name": "Open Lines" }, { "name": "Payment Systems" }, { "name": "Polls" }, { "name": "REST v3" }, { "name": "Signature" }, { "name": "Sites" }, { "name": "Tasks" }, { "name": "Telephony" }, { "name": "Time Management" }, { "name": "Trade Catalog" }, { "name": "Universal Lists" }, { "name": "User Consent" }, { "name": "Users" }, { "name": "Vibe" }, { "name": "Widgets" }, { "name": "Workgroups" } ], "paths": { "/BX24.placement.bindEvent": { "post": { "summary": "Set Up an Event Handler for the Interface BX24.placement.bindEvent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `BX24.placement.bindEvent` sets an event handler for the interface. The event must be registered on the calling side; otherwise, nothing will happen.", "operationId": "BX24_placement_bindEvent", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/ui-interaction/bx24-placement-bind-event.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| The name of the event to which the handler subscribes ||" }, "callback": { "type": "string", "description": "| The callback function." } }, "required": [ "event", "callback" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| The name of the event to which the handler subscribes ||" }, "callback": { "type": "string", "description": "| The callback function." } }, "required": [ "event", "callback" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.call": { "post": { "summary": "Call the Registered Interface Command BX24.placement.call", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `BX24.placement.call` invokes a registered interface command.", "operationId": "BX24_placement_call", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/ui-interaction/bx24-placement-call.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "command": { "type": "string", "description": "| The command to be invoked ||" }, "parameters": { "type": "object", "description": "| Parameters to be passed ||" }, "callback": { "type": "string", "description": "| Callback function ||" } }, "required": [ "command", "callback" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "command": { "type": "string", "description": "| The command to be invoked ||" }, "parameters": { "type": "object", "description": "| Parameters to be passed ||" }, "callback": { "type": "string", "description": "| Callback function ||" } }, "required": [ "command", "callback" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.getInterface": { "post": { "summary": "Get Information About the JS Interface of the Current Placement BX24.placement.getInterface", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `BX24.placement.getInterface` allows you to retrieve information about the JS interface of the current placement: a list of available commands and events.", "operationId": "BX24_placement_getInterface", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/ui-interaction/bx24-placement-get-interface.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callback": { "type": "string", "description": "| Callback function." } }, "required": [ "callback" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "callback": { "type": "string", "description": "| Callback function." } }, "required": [ "callback" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/BX24.placement.info": { "post": { "summary": "Get Information About the Call Context of BX24.placement.info", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `BX24.placement.info` retrieves information about the context of the embedding handler call. No parameters.", "operationId": "BX24_placement_info", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/ui-interaction/bx24-placement-info.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/CATALOG.MEASURE.ON.ADD": { "post": { "summary": "Event on Adding a Measurement Unit CATALOG.MEASURE.ON.ADD", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_MEASURE_ON_ADD", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the method catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the method catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.MEASURE.ON.DELETE": { "post": { "summary": "Event on Deleting Measurement Unit CATALOG.MEASURE.ON.DELETE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_MEASURE_ON_DELETE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can get all fields of the measurement unit by its identifier using the method catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can get all fields of the measurement unit by its identifier using the method catalog.measure.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.MEASURE.ON.UPDATE": { "post": { "summary": "Event on Measurement Unit Change CATALOG.MEASURE.ON.UPDATE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_MEASURE_ON_UPDATE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the catalog.measure.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the measurement unit." }, "ID": { "type": "string", "description": "| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the catalog.measure.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.ADD": { "post": { "summary": "Event on Adding Price CATALOG.PRICE.ON.ADD", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_ON_ADD", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. You can retrieve all price fields by its identifier using the catalog.price.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. You can retrieve all price fields by its identifier using the catalog.price.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.DELETE": { "post": { "summary": "Event on Price Deletion CATALOG.PRICE.ON.DELETE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_ON_DELETE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. You can retrieve all fields of the price by its identifier using the catalog.price.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. You can retrieve all fields of the price by its identifier using the catalog.price.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.ON.UPDATE": { "post": { "summary": "Event on Price Change CATALOG.PRICE.ON.UPDATE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when the price is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_ON_UPDATE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. All fields of the price can be retrieved by its identifier using the method catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with price properties." }, "ID": { "type": "string", "description": "| Price identifier. All fields of the price can be retrieved by its identifier using the method catalog.price.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.ADD": { "post": { "summary": "Event on Adding Price Type CATALOG.PRICE.TYPE.ON.ADD", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price type is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_TYPE_ON_ADD", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/events/catalog-price-type-on-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic code of the event ||" }, "event_handler_id": { "type": "integer", "description": "| Identifier of the event handler ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic code of the event ||" }, "event_handler_id": { "type": "integer", "description": "| Identifier of the event handler ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.DELETE": { "post": { "summary": "Event on Deletion of Price Type CATALOG.PRICE.TYPE.ON.DELETE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price type is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_TYPE_ON_DELETE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/events/catalog-price-type-on-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic code of the event ||" }, "event_handler_id": { "type": "integer", "description": "| Identifier of the event handler ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic code of the event ||" }, "event_handler_id": { "type": "integer", "description": "| Identifier of the event handler ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRICE.TYPE.ON.UPDATE": { "post": { "summary": "Event on Price Type Change CATALOG.PRICE.TYPE.ON.UPDATE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when the price type is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRICE_TYPE_ON_UPDATE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/events/catalog-price-type-on-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object containing event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price type." }, "ID": { "type": "string", "description": "| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.ADD": { "post": { "summary": "Event on Adding Product CATALOG.PRODUCT.ON.ADD", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a product is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRODUCT_ON_ADD", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/events/catalog-product-on-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.DELETE": { "post": { "summary": "Event on Product Deletion CATALOG.PRODUCT.ON.DELETE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a product is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRODUCT_ON_DELETE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/events/catalog-product-on-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.PRODUCT.ON.UPDATE": { "post": { "summary": "Event on Product Update CATALOG.PRODUCT.ON.UPDATE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a product is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_PRODUCT_ON_UPDATE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/events/catalog-product-on-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with product properties." }, "ID": { "type": "string", "description": "\\|" }, "TYPE": { "type": "integer", "description": "| Product type:" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.ADD": { "post": { "summary": "Event on Adding Price Rounding Rule CATALOG.ROUNDING.ON.ADD", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price rounding rule is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_ROUNDING_ON_ADD", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/events/catalog-rounding-on-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can get all fields of the price rounding rule by its identifier using the method catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can get all fields of the price rounding rule by its identifier using the method catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.DELETE": { "post": { "summary": "Event on Deletion of Price Rounding Rule CATALOG.ROUNDING.ON.DELETE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price rounding rule is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_ROUNDING_ON_DELETE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/events/catalog-rounding-on-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can retrieve all fields of the rounding rule by its identifier using the catalog.roundingRule.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can retrieve all fields of the rounding rule by its identifier using the catalog.roundingRule.get method ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/CATALOG.ROUNDING.ON.UPDATE": { "post": { "summary": "Event on Price Rounding Rule Update CATALOG.ROUNDING.ON.UPDATE", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when the price rounding rule is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)", "operationId": "CATALOG_ROUNDING_ON_UPDATE", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/events/catalog-rounding-on-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can get all fields of the price rounding rule by its identifier using the method catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Symbolic event code ||" }, "event_handler_id": { "type": "integer", "description": "| Event handler identifier ||" }, "data": { "type": "object", "description": "| Object with event data." }, "ts": { "type": "integer", "description": "| Timestamp of the event sent from the event queue ||" }, "auth": { "type": "object", "description": "| Object with authorization parameters and information about the account where the event occurred ||" }, "FIELDS": { "type": "object", "description": "| Object with properties of the price rounding rule." }, "ID": { "type": "string", "description": "| Identifier of the price rounding rule. You can get all fields of the price rounding rule by its identifier using the method catalog.roundingRule.get ||" } }, "required": [ "event", "event_handler_id", "data", "ts", "auth", "FIELDS", "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/access.name": { "post": { "summary": "Get Access Permission Names access.name", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `access.name` retrieves the names of access permissions.", "operationId": "access_name", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/access-name.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "array", "items": {}, "description": "| List of permission identifiers for which names need to be retrieved ||" } }, "required": [ "ACCESS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "array", "items": {}, "description": "| List of permission identifiers for which names need to be retrieved ||" } }, "required": [ "ACCESS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/ai.engine.list": { "post": { "summary": "Get the List of Services ai.engine.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `ai.engine.list` returns a list of registered AI services.", "operationId": "ai_engine_list", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/ai/ai-engine-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| An array in the following format:" }, "limit": { "type": "integer", "description": "| Maximum number of elements in the response ||" }, "ID": { "type": "integer", "description": "| Service identifier ||" }, "APP_CODE": { "type": "string", "description": "| Application code to which the service belongs." }, "NAME": { "type": "string", "description": "| Service name ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "CATEGORY": { "type": "string", "description": "| Service category ||" }, "COMPLETIONS_URL": { "type": "string", "description": "| Service endpoint URL ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Date and time of service creation in ISO 8601 format, e.g., 2026-03-20T09:50:00+03:00 ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| An array in the following format:" }, "limit": { "type": "integer", "description": "| Maximum number of elements in the response ||" }, "ID": { "type": "integer", "description": "| Service identifier ||" }, "APP_CODE": { "type": "string", "description": "| Application code to which the service belongs." }, "NAME": { "type": "string", "description": "| Service name ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "CATEGORY": { "type": "string", "description": "| Service category ||" }, "COMPLETIONS_URL": { "type": "string", "description": "| Service endpoint URL ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Date and time of service creation in ISO 8601 format, e.g., 2026-03-20T09:50:00+03:00 ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/ai.engine.register": { "post": { "summary": "Register the Service ai.engine.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `ai.engine.register` registers a custom AI service.", "operationId": "ai_engine_register", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/ai/ai-engine-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the service that will be displayed in the interface ||" }, "code": { "type": "string", "description": "| A unique code for the service." }, "category": { "type": "string", "description": "| The category of the service." }, "completions_url": { "type": "string", "description": "| The URL endpoint of the handler, which must respond with HTTP status `200` during registration verification (detailed description) ||" }, "settings": { "type": "object", "description": "| Additional settings for the service (detailed description) ||" }, "code_alias": { "type": "string", "description": "| The alias of the model." }, "model_context_type": { "type": "string", "description": "| The method of calculating context." }, "model_context_limit": { "type": "integer", "description": "| The context limit." } }, "required": [ "name", "code", "category", "completions_url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the service that will be displayed in the interface ||" }, "code": { "type": "string", "description": "| A unique code for the service." }, "category": { "type": "string", "description": "| The category of the service." }, "completions_url": { "type": "string", "description": "| The URL endpoint of the handler, which must respond with HTTP status `200` during registration verification (detailed description) ||" }, "settings": { "type": "object", "description": "| Additional settings for the service (detailed description) ||" }, "code_alias": { "type": "string", "description": "| The alias of the model." }, "model_context_type": { "type": "string", "description": "| The method of calculating context." }, "model_context_limit": { "type": "integer", "description": "| The context limit." } }, "required": [ "name", "code", "category", "completions_url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/ai.engine.unregister": { "post": { "summary": "Remove the ai.engine.unregister Service", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `ai.engine.unregister` removes a registered AI service.", "operationId": "ai_engine_unregister", "tags": [ "CoPilot / AI" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/ai/ai-engine-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Character code of the service to be removed ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Character code of the service to be removed ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "ai_admin" ] } ] } }, "/app.info": { "post": { "summary": "Show information about the app app.info", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `app.info` returns information about the application. No parameters.", "operationId": "app_info", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/app-info.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The object contains information about the application:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The object contains information about the application:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/app.option.get": { "post": { "summary": "Get Application-Linked Data app.option.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `app.option.get` retrieves data linked to the application. If no input is provided, it will return all properties recorded via [app.option.set](./app-option-set.md).", "operationId": "app_option_get", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/settings/app-option-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| A string, one of the keys from the property app.option.set. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| A string, one of the keys from the property app.option.set. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/app.option.set": { "post": { "summary": "Bind Data to the app.option.set Method", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `app.option.set` method binds data to the application.", "operationId": "app_option_set", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/settings/app-option-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "array", "items": {}, "description": "| An array where the key is the name of the property to be saved, and the value is the property value. If a value with a new key is passed, the method will write it; if an existing one, it will update it. ||" } }, "required": [ "options" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "options": { "type": "array", "items": {}, "description": "| An array where the key is the name of the property to be saved, and the value is the property value. If a value with a new key is passed, the method will write it; if an existing one, it will update it. ||" } }, "required": [ "options" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/biconnector.connector.add": { "post": { "summary": "Create Connector biconnector.connector.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.add` creates a new connector that allows integrating external data sources into Bitrix24.", "operationId": "biconnector_connector_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new connector. The object format:" }, "title": { "type": "string", "description": "| Connector name ||" }, "logo": { "type": "string", "description": "| Connector logo. Can be provided as a link to an image or a base64 formatted string, for example `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Connector description ||" }, "urlCheck": { "type": "string", "description": "| Connector endpoint for availability check, (detailed description) ||" }, "urlTableList": { "type": "string", "description": "| Connector endpoint for retrieving the list of tables, (detailed description) ||" }, "urlTableDescription": { "type": "string", "description": "| Connector endpoint for retrieving the description of a specific table, (detailed description) ||" }, "urlData": { "type": "string", "description": "| Connector endpoint for retrieving data from the selected table, (detailed description) ||" }, "settings": { "type": "array", "items": {}, "description": "| List of connection parameters, (detailed description) ||" }, "sort": { "type": "integer", "description": "| Connector sorting parameter. Default value is `100` ||" } }, "required": [ "fields", "title", "logo", "urlCheck", "urlTableList", "urlTableDescription", "urlData", "settings" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new connector. The object format:" }, "title": { "type": "string", "description": "| Connector name ||" }, "logo": { "type": "string", "description": "| Connector logo. Can be provided as a link to an image or a base64 formatted string, for example `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| Connector description ||" }, "urlCheck": { "type": "string", "description": "| Connector endpoint for availability check, (detailed description) ||" }, "urlTableList": { "type": "string", "description": "| Connector endpoint for retrieving the list of tables, (detailed description) ||" }, "urlTableDescription": { "type": "string", "description": "| Connector endpoint for retrieving the description of a specific table, (detailed description) ||" }, "urlData": { "type": "string", "description": "| Connector endpoint for retrieving data from the selected table, (detailed description) ||" }, "settings": { "type": "array", "items": {}, "description": "| List of connection parameters, (detailed description) ||" }, "sort": { "type": "integer", "description": "| Connector sorting parameter. Default value is `100` ||" } }, "required": [ "fields", "title", "logo", "urlCheck", "urlTableList", "urlTableDescription", "urlData", "settings" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.delete": { "post": { "summary": "Delete Connector biconnector.connector.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.delete` removes an existing connector. A connector can be deleted if it has no sources.", "operationId": "biconnector_connector_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the connector, can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the connector, can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.fields": { "post": { "summary": "Get Connector Fields biconnector.connector.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.fields` returns a description of the connector fields. A table with the description of standard fields can be found in the article [Connector: Overview of Methods](./index.md#fields).", "operationId": "biconnector_connector_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.get": { "post": { "summary": "Get Connector by ID biconnector.connector.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.get` returns information about the connector by its identifier.", "operationId": "biconnector_connector_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the connector, which can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the connector, which can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.list": { "post": { "summary": "Get the list of connectors biconnector.connector.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.list` returns a list of connectors based on a filter. It is an implementation of the list method for connectors.", "operationId": "biconnector_connector_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields that must be filled in the connectors in the selection. By default, all fields are taken ||" }, "filter": { "type": "object", "description": "| Filter for selecting connectors. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields that must be filled in the connectors in the selection. By default, all fields are taken ||" }, "filter": { "type": "object", "description": "| Filter for selecting connectors. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.connector.update": { "post": { "summary": "Update the biconnector.connector.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.connector.update` updates an existing connector.", "operationId": "biconnector_connector_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/connector/biconnector-connector-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Connector identifier, can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" }, "fields": { "type": "object", "description": "| An object containing the updated data. The object format:" }, "title": { "type": "string", "description": "| New connector name ||" }, "logo": { "type": "string", "description": "| New connector logo. Can be passed as a link to an image or a base64 formatted string, for example `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| New connector description ||" }, "urlCheck": { "type": "string", "description": "| New endpoint for checking the connector's availability, (detailed description) ||" }, "urlTableList": { "type": "string", "description": "| New endpoint for obtaining the list of tables, (detailed description) ||" }, "urlTableDescription": { "type": "string", "description": "| New endpoint for obtaining the description of a specific table, (detailed description) ||" }, "urlData": { "type": "string", "description": "| New endpoint for obtaining data from the selected table, (detailed description) ||" }, "settings": { "type": "array", "items": {}, "description": "| New list of connection parameters, (detailed description) ||" }, "sort": { "type": "integer", "description": "| New sorting parameter for the connector ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Connector identifier, can be obtained using the methods biconnector.connector.list and biconnector.connector.add ||" }, "fields": { "type": "object", "description": "| An object containing the updated data. The object format:" }, "title": { "type": "string", "description": "| New connector name ||" }, "logo": { "type": "string", "description": "| New connector logo. Can be passed as a link to an image or a base64 formatted string, for example `data:image/svg+xml;base64,PHN2ZyB3...` ||" }, "description": { "type": "string", "description": "| New connector description ||" }, "urlCheck": { "type": "string", "description": "| New endpoint for checking the connector's availability, (detailed description) ||" }, "urlTableList": { "type": "string", "description": "| New endpoint for obtaining the list of tables, (detailed description) ||" }, "urlTableDescription": { "type": "string", "description": "| New endpoint for obtaining the description of a specific table, (detailed description) ||" }, "urlData": { "type": "string", "description": "| New endpoint for obtaining data from the selected table, (detailed description) ||" }, "settings": { "type": "array", "items": {}, "description": "| New list of connection parameters, (detailed description) ||" }, "sort": { "type": "integer", "description": "| New sorting parameter for the connector ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.add": { "post": { "summary": "Create Dataset biconnector.dataset.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.add` creates a new dataset associated with a data source.", "operationId": "biconnector_dataset_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new dataset. The object format is:" }, "name": { "type": "string", "description": "| The name of the dataset. The name must start with a letter and can only use lowercase Latin letters `a-z`, numbers, and the underscore `_`. The maximum length of the name is 230 characters. ||" }, "externalName": { "type": "string", "description": "| The name of the dataset in the external source, in the application. ||" }, "externalCode": { "type": "string", "description": "| A unique code for the dataset in the external source, used when retrieving data. ||" }, "sourceId": { "type": "integer", "description": "| The identifier of the source, which can be obtained using the methods biconnector.source.list or biconnector.source.add. ||" }, "description": { "type": "string", "description": "| Description of the dataset. ||" } }, "required": [ "fields", "name", "externalName", "externalCode", "sourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new dataset. The object format is:" }, "name": { "type": "string", "description": "| The name of the dataset. The name must start with a letter and can only use lowercase Latin letters `a-z`, numbers, and the underscore `_`. The maximum length of the name is 230 characters. ||" }, "externalName": { "type": "string", "description": "| The name of the dataset in the external source, in the application. ||" }, "externalCode": { "type": "string", "description": "| A unique code for the dataset in the external source, used when retrieving data. ||" }, "sourceId": { "type": "integer", "description": "| The identifier of the source, which can be obtained using the methods biconnector.source.list or biconnector.source.add. ||" }, "description": { "type": "string", "description": "| Description of the dataset. ||" } }, "required": [ "fields", "name", "externalName", "externalCode", "sourceId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.delete": { "post": { "summary": "Delete dataset biconnector.dataset.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.delete` removes an existing dataset.", "operationId": "biconnector_dataset_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list or biconnector.dataset.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list or biconnector.dataset.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.fields": { "post": { "summary": "Get Fields of the Dataset biconnector.dataset.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.fields` returns a description of the dataset fields. A table with descriptions of standard fields can be found in the article [Datasets: Overview of Methods](./index.md#dataset).", "operationId": "biconnector_dataset_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.fields.update": { "post": { "summary": "Update Dataset Fields biconnector.dataset.fields.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.fields.update` updates the fields of an existing dataset.", "operationId": "biconnector_dataset_fields_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-fields-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list or biconnector.dataset.add ||" }, "add": { "type": "object", "description": "| Object containing an array of fields to be added with the following structure:" }, "update": { "type": "object", "description": "| Object containing an array of fields to be updated with the following structure:" }, "delete": { "type": "string", "description": "| Object containing an array of field identifiers for deletion. Field identifiers can be obtained using the method biconnector.dataset.get ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list or biconnector.dataset.add ||" }, "add": { "type": "object", "description": "| Object containing an array of fields to be added with the following structure:" }, "update": { "type": "object", "description": "| Object containing an array of fields to be updated with the following structure:" }, "delete": { "type": "string", "description": "| Object containing an array of field identifiers for deletion. Field identifiers can be obtained using the method biconnector.dataset.get ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.get": { "post": { "summary": "Get dataset by id biconnector.dataset.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.get` returns information about a dataset by its identifier.", "operationId": "biconnector_dataset_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, which can be obtained using the methods biconnector.dataset.list and biconnector.dataset.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, which can be obtained using the methods biconnector.dataset.list and biconnector.dataset.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.list": { "post": { "summary": "Get the list of datasets biconnector.dataset.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.list` returns a list of datasets based on a filter. It is an implementation of the listing method for datasets.", "operationId": "biconnector_dataset_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that must be populated in the datasets in the selection. By default, all fields are taken." }, "filter": { "type": "object", "description": "| Filter for selecting datasets. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through the results, pass the page number. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that must be populated in the datasets in the selection. By default, all fields are taken." }, "filter": { "type": "object", "description": "| Filter for selecting datasets. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through the results, pass the page number. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.dataset.update": { "post": { "summary": "Update Dataset biconnector.dataset.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.dataset.update` updates an existing dataset.", "operationId": "biconnector_dataset_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/dataset/biconnector-dataset-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list and biconnector.dataset.add ||" }, "fields": { "type": "object", "description": "| An object containing the updated data." }, "description": { "type": "string", "description": "| Description of the dataset ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the dataset, can be obtained using the methods biconnector.dataset.list and biconnector.dataset.add ||" }, "fields": { "type": "object", "description": "| An object containing the updated data." }, "description": { "type": "string", "description": "| Description of the dataset ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.add": { "post": { "summary": "Create Source biconnector.source.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.add` creates a new data source associated with the connector.", "operationId": "biconnector_source_add", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new source. The object format is:" }, "title": { "type": "string", "description": "| Source name ||" }, "description": { "type": "string", "description": "| Source description ||" }, "active": { "type": "boolean", "description": "| Source activity." }, "connectorId": { "type": "integer", "description": "| Connector identifier, can be obtained using the methods biconnector.connector.list or biconnector.connector.add ||" }, "settings": { "type": "object", "description": "| A list of parameters for authorization, passed as an object where the key is the `code` of the parameter." } }, "required": [ "fields", "title", "connectorId", "settings" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing data to create a new source. The object format is:" }, "title": { "type": "string", "description": "| Source name ||" }, "description": { "type": "string", "description": "| Source description ||" }, "active": { "type": "boolean", "description": "| Source activity." }, "connectorId": { "type": "integer", "description": "| Connector identifier, can be obtained using the methods biconnector.connector.list or biconnector.connector.add ||" }, "settings": { "type": "object", "description": "| A list of parameters for authorization, passed as an object where the key is the `code` of the parameter." } }, "required": [ "fields", "title", "connectorId", "settings" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.delete": { "post": { "summary": "Delete source biconnector.source.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.delete` removes an existing connection. A connection can be deleted if it has no datasets.", "operationId": "biconnector_source_delete", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the connection, can be obtained using the methods biconnector.source.list or biconnector.source.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the connection, can be obtained using the methods biconnector.source.list or biconnector.source.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.fields": { "post": { "summary": "Get Source Fields of biconnector.source.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.fields` returns a description of the source fields. A table with the description of standard fields can be found in the article [Sources: Overview of Methods](./index.md#fields).", "operationId": "biconnector_source_fields", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.get": { "post": { "summary": "Get Source by ID biconnector.source.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.get` returns information about the source by its identifier.", "operationId": "biconnector_source_get", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source, which can be obtained using the methods biconnector.source.list and biconnector.source.add ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source, which can be obtained using the methods biconnector.source.list and biconnector.source.add ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.list": { "post": { "summary": "Get the list of sources biconnector.source.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.list` returns a list of sources based on a filter. It is an implementation of the list method for sources.", "operationId": "biconnector_source_list", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields that must be filled in the sources in the selection. By default, all fields are taken ||" }, "filter": { "type": "object", "description": "| Filter for selecting sources. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields that must be filled in the sources in the selection. By default, all fields are taken ||" }, "filter": { "type": "object", "description": "| Filter for selecting sources. Example format:" }, "order": { "type": "object", "description": "| Sorting parameters. Example format:" }, "page": { "type": "integer", "description": "| Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/biconnector.source.update": { "post": { "summary": "Change source biconnector.source.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `biconnector.source.update` updates an existing source.", "operationId": "biconnector_source_update", "tags": [ "BIconnector" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/biconnector/source/biconnector-source-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source, can be obtained using the methods biconnector.source.list and biconnector.source.add ||" }, "fields": { "type": "object", "description": "| Object containing the updated data." }, "title": { "type": "string", "description": "| New name of the source ||" }, "description": { "type": "string", "description": "| New description of the source ||" }, "active": { "type": "boolean", "description": "| Activity status of the source ||" }, "settings": { "type": "object", "description": "| List of parameters for authorization, passed as an object where the key is the `code` of the parameter." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source, can be obtained using the methods biconnector.source.list and biconnector.source.add ||" }, "fields": { "type": "object", "description": "| Object containing the updated data." }, "title": { "type": "string", "description": "| New name of the source ||" }, "description": { "type": "string", "description": "| New description of the source ||" }, "active": { "type": "boolean", "description": "| Activity status of the source ||" }, "settings": { "type": "object", "description": "| List of parameters for authorization, passed as an object where the key is the `code` of the parameter." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "biconnector" ] } ] } }, "/bizproc.activity.add": { "post": { "summary": "Add a New Action bizproc.activity.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new action for use in workflows. The method works only in the context of an [application](../../../settings/app-installation/index.md). Each document generates its own set of field types. For example, in CRM, there is a field of type Address `UF:address`. To use this field type in your actions, specify the CRM document type in `DOCUMENT_TYPE` and describe the field properties in `PROPERTIES`.", "operationId": "bizproc_activity_add", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the action. It must be unique within the application." }, "HANDLER": { "type": "string", "description": "| URL to which the action will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the action wait for a response from the application. Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with action parameters. Contains objects, each describing a parameter of the action." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the action. Contains objects, each describing a parameter of the action." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules to restrict the action by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the action in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Requirement of the parameter. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Multiplicity of the parameter. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "HANDLER", "PLACEMENT_HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the action. It must be unique within the application." }, "HANDLER": { "type": "string", "description": "| URL to which the action will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the action wait for a response from the application. Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with action parameters. Contains objects, each describing a parameter of the action." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the action. Contains objects, each describing a parameter of the action." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules to restrict the action by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the action in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Requirement of the parameter. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Multiplicity of the parameter. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "HANDLER", "PLACEMENT_HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.delete": { "post": { "summary": "Delete Action bizproc.activity.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an action for workflows that was added by the application. It only works in the context of the [application](../../../settings/app-installation/index.md). When the application is deleted or updated, the associated actions are removed from the list of actions in the workflow designer. If the action is used in a workflow, it is blocked and can only be removed from the scheme. Upon reinstalling the application, the action becomes available again.", "operationId": "bizproc_activity_delete", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Symbolic identifier of the application action ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Symbolic identifier of the application action ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.list": { "post": { "summary": "Get a List of Application Actions bizproc.activity.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method retrieves a list of actions set by the application. It only works in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "bizproc_activity_list", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.log": { "post": { "summary": "Write Information to the Business Process Log bizproc.activity.log", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method logs information into the business process log. Event logging must be enabled in the business process template.", "operationId": "bizproc_activity_log", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| A unique key required to send an event to the business process." }, "LOG_MESSAGE": { "type": "string", "description": "| Message to be logged ||" } }, "required": [ "EVENT_TOKEN", "LOG_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| A unique key required to send an event to the business process." }, "LOG_MESSAGE": { "type": "string", "description": "| Message to be logged ||" } }, "required": [ "EVENT_TOKEN", "LOG_MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.activity.update": { "post": { "summary": "Update Action bizproc.activity.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a business process action added by the application. It works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "bizproc_activity_update", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the action ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the business process action ||" }, "HANDLER": { "type": "string", "description": "| URL to which the action will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the action wait for a response from the application. Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the action. Contains objects, each describing a parameter of the action." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the action. Contains objects, each describing a parameter of the action." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for limiting the action by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the action in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Parameter requirement. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Parameter multiplicity. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "FIELDS", "HANDLER", "PLACEMENT_HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the action ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the business process action ||" }, "HANDLER": { "type": "string", "description": "| URL to which the action will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the action wait for a response from the application. Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the action. Contains objects, each describing a parameter of the action." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the action. Contains objects, each describing a parameter of the action." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for limiting the action by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the action in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Parameter requirement. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Parameter multiplicity. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "FIELDS", "HANDLER", "PLACEMENT_HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.event.send": { "post": { "summary": "Return Parameters to Action or Automation Rule bizproc.event.send", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the output parameters to the Automation rule or action that were specified during the registration or update of the Automation rule or action.", "operationId": "bizproc_event_send", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-event-send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| A special token that is sent to the application handler when the action or Automation rule is executed. The value of this token is received by the handler in the input data array." }, "RETURN_VALUES": { "type": "object", "description": "| An array of returned values from the action or Automation rule. It specifies the values of properties that were registered as additional results `RETURN_PROPERTIES` by the methods:" }, "LOG_MESSAGE": { "type": "string", "description": "| Text for the business process log." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "EVENT_TOKEN": { "type": "string", "description": "| A special token that is sent to the application handler when the action or Automation rule is executed. The value of this token is received by the handler in the input data array." }, "RETURN_VALUES": { "type": "object", "description": "| An array of returned values from the action or Automation rule. It specifies the values of properties that were registered as additional results `RETURN_PROPERTIES` by the methods:" }, "LOG_MESSAGE": { "type": "string", "description": "| Text for the business process log." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.add": { "post": { "summary": "Register a New Automation Rule bizproc.robot.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `bizproc.robot.add` registers a new Automation rule. It only works in the context of an [application](../../../settings/app-installation/index.md).", "operationId": "bizproc_robot_add", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the Automation rule. It must be unique within the application." }, "HANDLER": { "type": "string", "description": "| URL to which the Automation rule will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the Automation rule wait for a response from the application? Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the Automation rule. Contains objects, each describing a parameter of the Automation rule." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the Automation rule. Contains objects, each describing a parameter of the Automation rule." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for restricting the Automation rule by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the Automation rule in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` in the format:" }, "Required": { "type": "boolean", "description": "| Parameter requirement. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Parameter multiplicity. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter. For `Type = 'select'`, specify the key from `Options` ||" } }, "required": [ "CODE", "HANDLER", "PLACEMENT_HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the Automation rule. It must be unique within the application." }, "HANDLER": { "type": "string", "description": "| URL to which the Automation rule will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the Automation rule wait for a response from the application? Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the Automation rule. Contains objects, each describing a parameter of the Automation rule." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the Automation rule. Contains objects, each describing a parameter of the Automation rule." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for restricting the Automation rule by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the Automation rule in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` in the format:" }, "Required": { "type": "boolean", "description": "| Parameter requirement. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Parameter multiplicity. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter. For `Type = 'select'`, specify the key from `Options` ||" } }, "required": [ "CODE", "HANDLER", "PLACEMENT_HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.delete": { "post": { "summary": "Delete Registered Robot bizproc.robot.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a robot registered by the application. It only works in the context of the [application](../../../settings/app-installation/index.md). When the application is deleted or updated, the associated robots are removed from the list of robots. If the robot is in use, it is blocked and can only be removed from the workflow. Upon reinstalling the application, the robot becomes available again.", "operationId": "bizproc_robot_delete", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Symbolic identifier of the application robot ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Symbolic identifier of the application robot ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.list": { "post": { "summary": "Get a list of registered application robots bizproc.robot.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of robots registered by the application. It works only in the context of the [application](../../../settings/app-installation/index.md). No parameters.", "operationId": "bizproc_robot_list", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| List of application robot identifiers ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| List of application robot identifiers ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.robot.update": { "post": { "summary": "Update Fields of the Automation Rule bizproc.robot.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the fields of the Automation Rule registered by the application. It only works in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "bizproc_robot_update", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the Automation Rule ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the Automation Rule ||" }, "HANDLER": { "type": "string", "description": "| URL to which the Automation Rule will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the Automation Rule wait for a response from the application? Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for restricting the Automation Rule by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the Automation Rule in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Requirement of the parameter. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Multiplicity of the parameter. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "FIELDS", "HANDLER", "PLACEMENT_HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal identifier of the Automation Rule ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the Automation Rule ||" }, "HANDLER": { "type": "string", "description": "| URL to which the Automation Rule will send data via the Bitrix24 queue server." }, "AUTH_USER_ID": { "type": "integer", "description": "| Identifier of the user whose token will be passed to the application ||" }, "USE_SUBSCRIPTION": { "type": "boolean", "description": "| Should the Automation Rule wait for a response from the application? Possible values:" }, "PROPERTIES": { "type": "object", "description": "| Object with parameters of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule." }, "RETURN_PROPERTIES": { "type": "object", "description": "| Object with additional results of the Automation Rule. Contains objects, each describing a parameter of the Automation Rule." }, "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:" }, "FILTER": { "type": "object", "description": "| Object with rules for restricting the Automation Rule by document type and edition." }, "USE_PLACEMENT": { "type": "boolean", "description": "| Allows opening additional settings for the Automation Rule in the application slider. Possible values:" }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'` ||" }, "Type": { "type": "string", "description": "| Type of the parameter. Basic values:" }, "Options": { "type": "array", "items": {}, "description": "| Array of values for the parameter of type list `'TYPE': select'` like:" }, "Required": { "type": "boolean", "description": "| Requirement of the parameter. Possible values:" }, "Multiple": { "type": "boolean", "description": "| Multiplicity of the parameter. Possible values:" }, "Default": { "type": "string", "description": "| Default value of the parameter ||" } }, "required": [ "CODE", "FIELDS", "HANDLER", "PLACEMENT_HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.complete": { "post": { "summary": "Complete a business process task bizproc.task.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method completes a business process task: - Document approval - Document acknowledgment", "operationId": "bizproc_task_complete", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-task/bizproc-task-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "integer", "description": "| Task identifier." }, "COMMENT": { "type": "string", "description": "| User comment." }, "FIELDS": { "type": "object", "description": "| An object describing fields for completing tasks with a request for additional information in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" } }, "required": [ "TASK_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "integer", "description": "| Task identifier." }, "COMMENT": { "type": "string", "description": "| User comment." }, "FIELDS": { "type": "object", "description": "| An object describing fields for completing tasks with a request for additional information in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" } }, "required": [ "TASK_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.delegate": { "post": { "summary": "Delegate a workflow task bizproc.task.delegate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method delegates a workflow task. You can only delegate your own task. - [Actions: Tasks](https://helpdesk.bitrix24.com/open/11466058/)", "operationId": "bizproc_task_delegate", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-task/bizproc-task-delegate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_IDS": { "type": "array", "items": {}, "description": "| List of task identifiers." }, "FROM_USER_ID": { "type": "integer", "description": "| Identifier of the user from whom the tasks will be delegated." }, "TO_USER_ID": { "type": "integer", "description": "| Identifier of the user to whom the tasks will be delegated." } }, "required": [ "TASK_IDS", "FROM_USER_ID", "TO_USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_IDS": { "type": "array", "items": {}, "description": "| List of task identifiers." }, "FROM_USER_ID": { "type": "integer", "description": "| Identifier of the user from whom the tasks will be delegated." }, "TO_USER_ID": { "type": "integer", "description": "| Identifier of the user to whom the tasks will be delegated." } }, "required": [ "TASK_IDS", "FROM_USER_ID", "TO_USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.task.list": { "post": { "summary": "Get a List of Workflow Tasks bizproc.task.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. The method `bizproc.task.list` retrieves a list of workflow tasks. A portal administrator can request all tasks or tasks of any user. A regular user can only request their own tasks or those of their subordinates. To request their own tasks, the `USER_ID` filter does not need to be specified.", "operationId": "bizproc_task_list", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-task/bizproc-task-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing a list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "START": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing a list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "START": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.instances": { "post": { "summary": "Get a list of running workflows bizproc.workflow.instances", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of running workflows. There is an old method `bizproc.workflow.instance.list` — an alias for the method `bizproc.workflow.instances`. It accepts the same parameters and returns the same results. Support for `bizproc.workflow.instance.list` is not guaranteed in the future, so we recommend using `bizproc.workflow.instances`.", "operationId": "bizproc_workflow_instances", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-workflow-instances.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of running workflows in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the list of running workflows in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of running workflows in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the list of running workflows in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.kill": { "post": { "summary": "Delete Running Process bizproc.workflow.kill", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the running workflow along with all process data.", "operationId": "bizproc_workflow_kill", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-workflow-kill.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the workflow ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the workflow ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.start": { "post": { "summary": "Start Business Process bizproc.workflow.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `bizproc.workflow.start` initiates a new business process. You can only start a business process using REST on paid plans, demo licenses, and NFR licenses.", "operationId": "bizproc_workflow_start", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-workflow-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TEMPLATE_ID": { "type": "integer", "description": "| Identifier of the business process template ||" }, "DOCUMENT_ID": { "type": "array", "items": {}, "description": "| Identifier of the document to start the business process in the format [`module`, `object`, `ELEMENT_ID`]." }, "PARAMETERS": { "type": "object", "description": "| Values for the parameters of the business process template." } }, "required": [ "TEMPLATE_ID", "DOCUMENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TEMPLATE_ID": { "type": "integer", "description": "| Identifier of the business process template ||" }, "DOCUMENT_ID": { "type": "array", "items": {}, "description": "| Identifier of the document to start the business process in the format [`module`, `object`, `ELEMENT_ID`]." }, "PARAMETERS": { "type": "object", "description": "| Values for the parameters of the business process template." } }, "required": [ "TEMPLATE_ID", "DOCUMENT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.add": { "post": { "summary": "Add Business Process Template bizproc.workflow.template.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a business process template from a file. The business process template must be pre-configured. Export the completed template [to a file](https://helpdesk.bitrix24.com/open/8605753/) with the `.bpt` extension. The resulting file can be added as a template to the desired Bitrix24. The method works only in the context of an [application](../../../settings/app-installation/index.md). The system binds the new template to the application.", "operationId": "bizproc_workflow_template_add", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/template/bizproc-workflow-template-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type. Consists of three string-type elements. They define to which type of objects the new business process template should be attached." }, "NAME": { "type": "string", "description": "| Template name ||" }, "DESCRIPTION": { "type": "string", "description": "| Template description ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Content of the business process template file in `.bpt` format." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execution settings for the template. Can have the value:" } }, "required": [ "DOCUMENT_TYPE", "NAME", "TEMPLATE_DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DOCUMENT_TYPE": { "type": "array", "items": {}, "description": "| Document type. Consists of three string-type elements. They define to which type of objects the new business process template should be attached." }, "NAME": { "type": "string", "description": "| Template name ||" }, "DESCRIPTION": { "type": "string", "description": "| Template description ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Content of the business process template file in `.bpt` format." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execution settings for the template. Can have the value:" } }, "required": [ "DOCUMENT_TYPE", "NAME", "TEMPLATE_DATA" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.delete": { "post": { "summary": "Delete Business Process Template bizproc.workflow.template.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a business process template. It allows you to remove templates that were created using the method [bizproc.workflow.template.add](./bizproc-workflow-template-add.md). These templates are tied to the application and can only be deleted in the context of the same [application](../../../settings/app-installation/index.md) in which they were created.", "operationId": "bizproc_workflow_template_delete", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/template/bizproc-workflow-template-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the business process template ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the business process template ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.list": { "post": { "summary": "Get the list of templates bizproc.workflow.template.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of business process templates.", "operationId": "bizproc_workflow_template_list", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/template/bizproc-workflow-template-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of business process templates in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of launched business processes in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." }, "ID": { "type": "integer", "description": "| Identifier of the business process template ||" }, "MODULE_ID": { "type": "string", "description": "| Identifier of the module by document. Possible values:" }, "ENTITY": { "type": "string", "description": "| Identifier of the object by document. Possible values:" }, "DOCUMENT_TYPE": { "type": "integer", "description": "| Document type. Possible values:" }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execute flag. Can take values:" }, "NAME": { "type": "string", "description": "| Template name ||" }, "TEMPLATE": { "type": "array", "items": {}, "description": "| Array with the description of the template's action structure ||" }, "PARAMETERS": { "type": "array", "items": {}, "description": "| Template parameters ||" }, "VARIABLES": { "type": "array", "items": {}, "description": "| Template variables ||" }, "CONSTANTS": { "type": "array", "items": {}, "description": "| Template constants ||" }, "MODIFIED": { "type": "string", "format": "date-time", "description": "| Date of last modification ||" }, "IS_MODIFIED": { "type": "boolean", "description": "| Whether the template has been modified. Possible values:" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user who created or modified the template ||" }, "SYSTEM_CODE": { "type": "string", "description": "| System code of the template." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select." }, "FILTER": { "type": "object", "description": "| An object for filtering the list of business process templates in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of launched business processes in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." }, "ID": { "type": "integer", "description": "| Identifier of the business process template ||" }, "MODULE_ID": { "type": "string", "description": "| Identifier of the module by document. Possible values:" }, "ENTITY": { "type": "string", "description": "| Identifier of the object by document. Possible values:" }, "DOCUMENT_TYPE": { "type": "integer", "description": "| Document type. Possible values:" }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execute flag. Can take values:" }, "NAME": { "type": "string", "description": "| Template name ||" }, "TEMPLATE": { "type": "array", "items": {}, "description": "| Array with the description of the template's action structure ||" }, "PARAMETERS": { "type": "array", "items": {}, "description": "| Template parameters ||" }, "VARIABLES": { "type": "array", "items": {}, "description": "| Template variables ||" }, "CONSTANTS": { "type": "array", "items": {}, "description": "| Template constants ||" }, "MODIFIED": { "type": "string", "format": "date-time", "description": "| Date of last modification ||" }, "IS_MODIFIED": { "type": "boolean", "description": "| Whether the template has been modified. Possible values:" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user who created or modified the template ||" }, "SYSTEM_CODE": { "type": "string", "description": "| System code of the template." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.template.update": { "post": { "summary": "Update Business Process Template bizproc.workflow.template.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a business process template. It allows you to update templates that were created using the [bizproc.workflow.template.add](./bizproc-workflow-template-add.md) method. These templates are tied to the application and can only be updated in the context of the same [application](../../../settings/app-installation/index.md) that created them.", "operationId": "bizproc_workflow_template_update", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/template/bizproc-workflow-template-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the template to be updated ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the business process template." }, "NAME": { "type": "string", "description": "| Name of the template ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the template ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Content of the file with the business process template in `.bpt` format." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execution settings for the template. Can have the following values:" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the template to be updated ||" }, "FIELDS": { "type": "object", "description": "| Object with fields of the business process template." }, "NAME": { "type": "string", "description": "| Name of the template ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the template ||" }, "TEMPLATE_DATA": { "type": "string", "description": "| Content of the file with the business process template in `.bpt` format." }, "AUTO_EXECUTE": { "type": "integer", "description": "| Auto-execution settings for the template. Can have the following values:" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/bizproc.workflow.terminate": { "post": { "summary": "Stop Active Workflow bizproc.workflow.terminate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method stops the specified workflow. All data related to the workflow will be preserved.", "operationId": "bizproc_workflow_terminate", "tags": [ "Business Processes" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-workflow-terminate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the workflow to be stopped." }, "STATUS": { "type": "string", "description": "| Set the status text. ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the workflow to be stopped." }, "STATUS": { "type": "string", "description": "| Set the status text. ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "bizproc" ] } ] } }, "/booking.v1.booking.add": { "post": { "summary": "Add Booking booking.v1.booking.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.add` adds a new booking for a resource.", "operationId": "booking_v1_booking_add", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| An array of resource IDs for the booking." }, "name": { "type": "string", "description": "| The name of the booking." }, "description": { "type": "string", "description": "| The description of the booking." }, "datePeriod": { "type": "object", "description": "| An object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| The start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}`||" }, "to": { "type": "object", "description": "| The end time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "fields", "resourceIds", "datePeriod", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| An array of resource IDs for the booking." }, "name": { "type": "string", "description": "| The name of the booking." }, "description": { "type": "string", "description": "| The description of the booking." }, "datePeriod": { "type": "object", "description": "| An object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| The start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}`||" }, "to": { "type": "object", "description": "| The end time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "fields", "resourceIds", "datePeriod", "from", "to" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.list": { "post": { "summary": "Get the list of booking clients booking.v1.booking.client.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.client.list` returns a list of clients for the specified booking.", "operationId": "booking_v1_booking_client_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/client/booking-v1-booking-client-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.set": { "post": { "summary": "Add Clients to Booking booking.v1.booking.client.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.client.set` sets clients for the specified booking.", "operationId": "booking_v1_booking_client_set", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/client/booking-v1-booking-client-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." }, "clients": { "type": "array", "items": {}, "description": "| An array of objects containing information about clients (detailed description) ||" }, "id": { "type": "integer", "description": "| Client identifier, can be obtained using the method crm.item.list for contacts and companies ||" }, "type": { "type": "object", "description": "| Client type in the format `{\"module\": \"crm\", \"code\": \"CONTACT\"}`." } }, "required": [ "bookingId", "clients", "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." }, "clients": { "type": "array", "items": {}, "description": "| An array of objects containing information about clients (detailed description) ||" }, "id": { "type": "integer", "description": "| Client identifier, can be obtained using the method crm.item.list for contacts and companies ||" }, "type": { "type": "object", "description": "| Client type in the format `{\"module\": \"crm\", \"code\": \"CONTACT\"}`." } }, "required": [ "bookingId", "clients", "id", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.client.unset": { "post": { "summary": "Remove clients from booking booking.v1.booking.client.unset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.client.unset` removes clients for the specified booking.", "operationId": "booking_v1_booking_client_unset", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/client/booking-v1-booking-client-unset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.createfromwaitlist": { "post": { "summary": "Create a Booking from the Waitlist booking.v1.booking.createfromwaitlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.createfromwaitlist` creates a booking based on an entry from the waitlist.", "operationId": "booking_v1_booking_createfromwaitlist", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-createfromwaitlist.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the entry in the waitlist." }, "fields": { "type": "object", "description": "| Object containing field values for creating a booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Array of resource identifiers for the booking." }, "name": { "type": "string", "description": "| Name of the booking." }, "description": { "type": "string", "description": "| Description of the booking." }, "datePeriod": { "type": "object", "description": "| Object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| Start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}`||" }, "to": { "type": "object", "description": "| End time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "waitListId", "resourceIds", "datePeriod", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the entry in the waitlist." }, "fields": { "type": "object", "description": "| Object containing field values for creating a booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Array of resource identifiers for the booking." }, "name": { "type": "string", "description": "| Name of the booking." }, "description": { "type": "string", "description": "| Description of the booking." }, "datePeriod": { "type": "object", "description": "| Object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| Start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}`||" }, "to": { "type": "object", "description": "| End time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "waitListId", "resourceIds", "datePeriod", "from", "to" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.delete": { "post": { "summary": "Delete Booking booking.v1.booking.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.delete` removes a booking.", "operationId": "booking_v1_booking_delete", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.list": { "post": { "summary": "Get Booking Connections booking.v1.booking.externalData.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.externalData.list` returns connections for the specified booking.", "operationId": "booking_v1_booking_externalData_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.set": { "post": { "summary": "Set Connections for Booking booking.v1.booking.externalData.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.externalData.set` establishes connections for the specified booking.", "operationId": "booking_v1_booking_externalData_set", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." }, "externalData": { "type": "array", "items": {}, "description": "| Array of objects containing items for binding (detailed description) ||" }, "moduleId": { "type": "string", "description": "| Module identifier, for example `crm` ||" }, "entityTypeId": { "type": "string", "description": "| Object type ID, for example `DEAL` ||" }, "value": { "type": "string", "description": "| Item ID, for example `1` ||" } }, "required": [ "bookingId", "externalData", "moduleId", "entityTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." }, "externalData": { "type": "array", "items": {}, "description": "| Array of objects containing items for binding (detailed description) ||" }, "moduleId": { "type": "string", "description": "| Module identifier, for example `crm` ||" }, "entityTypeId": { "type": "string", "description": "| Object type ID, for example `DEAL` ||" }, "value": { "type": "string", "description": "| Item ID, for example `1` ||" } }, "required": [ "bookingId", "externalData", "moduleId", "entityTypeId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.externalData.unset": { "post": { "summary": "Remove connections for booking booking.v1.booking.externalData.unset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.externalData.unset` removes connections for the specified booking.", "operationId": "booking_v1_booking_externalData_unset", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/external-data/booking-v1-booking-externaldata-unset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| Booking identifier." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.get": { "post": { "summary": "Get Information About Booking booking.v1.booking.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.get` returns information about a booking by its identifier.", "operationId": "booking_v1_booking_get", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.list": { "post": { "summary": "Get the list of bookings booking.v1.booking.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.list` returns a list of bookings based on the filter. It is an implementation of the listing method for bookings.", "operationId": "booking_v1_booking_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering the list of bookings, description of available fields below ||" }, "ORDER": { "type": "object", "description": "| Object for sorting the list of bookings. The sorting direction can take the following values:" }, "within": { "type": "object", "description": "| Object for filtering by booking time in the format `{\"dateFrom\": \"0\", \"dateTo\": \"1739262600\"}`, where" }, "client": { "type": "object", "description": "| Object for filtering by client, accepts an array of `entities` objects with fields" }, "id": { "type": "string", "description": "| Sort by identifier ||" }, "dateFrom": { "type": "string", "description": "| Sort by start date ||" }, "dateTo": { "type": "string", "description": "| Sort by end date ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering the list of bookings, description of available fields below ||" }, "ORDER": { "type": "object", "description": "| Object for sorting the list of bookings. The sorting direction can take the following values:" }, "within": { "type": "object", "description": "| Object for filtering by booking time in the format `{\"dateFrom\": \"0\", \"dateTo\": \"1739262600\"}`, where" }, "client": { "type": "object", "description": "| Object for filtering by client, accepts an array of `entities` objects with fields" }, "id": { "type": "string", "description": "| Sort by identifier ||" }, "dateFrom": { "type": "string", "description": "| Sort by start date ||" }, "dateTo": { "type": "string", "description": "| Sort by end date ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.booking.update": { "post": { "summary": "Update Booking booking.v1.booking.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.booking.update` updates the booking information.", "operationId": "booking_v1_booking_update", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking/booking-v1-booking-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" }, "fields": { "type": "object", "description": "| Object containing field values for updating the booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Array of resource identifiers." }, "name": { "type": "string", "description": "| Booking name ||" }, "description": { "type": "string", "description": "| Booking description ||" }, "datePeriod": { "type": "object", "description": "| Object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| Start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}` ||" }, "to": { "type": "object", "description": "| End time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "id", "fields", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Booking identifier ||" }, "fields": { "type": "object", "description": "| Object containing field values for updating the booking (detailed description) ||" }, "resourceIds": { "type": "array", "items": {}, "description": "| Array of resource identifiers." }, "name": { "type": "string", "description": "| Booking name ||" }, "description": { "type": "string", "description": "| Booking description ||" }, "datePeriod": { "type": "object", "description": "| Object containing the booking time (detailed description) ||" }, "from": { "type": "object", "description": "| Start time of the booking in the format `{\"timestamp\": \"1723446900\", \"timezone\": \"Europe/Berlin\"}` ||" }, "to": { "type": "object", "description": "| End time of the booking in the format `{\"timestamp\": \"1723447800\", \"timezone\": \"Europe/Berlin\"}` ||" } }, "required": [ "id", "fields", "from", "to" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.clienttype.list": { "post": { "summary": "Get a list of client types booking.v1.clienttype.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.clienttype.list` returns a list of available client types. The method may not return a client type if no bookings have been created with it. By default, two client types are available: contact and company.", "operationId": "booking_v1_clienttype_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/booking-v1-clienttype-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.add": { "post": { "summary": "Add a New Resource booking.v1.resource.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.add` adds a new resource.", "operationId": "booking_v1_resource_add", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/booking-v1-resource-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a resource (detailed description) ||" }, "name": { "type": "string", "description": "| The name of the resource ||" }, "description": { "type": "string", "description": "| The description of the resource." }, "typeId": { "type": "integer", "description": "| The identifier of the resource type." }, "isMain": { "type": "string", "description": "| How to display the resource. Possible values:" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| The type of the booking notification message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic confirmation of the booking. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| The type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| The type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Feedback request. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| The type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| The type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| The delay after which the client receives a booking message. Specified in seconds." }, "reminderDelay": { "type": "integer", "description": "| The time before the booking when the client receives a reminder. Specified in seconds." }, "delayedDelay": { "type": "integer", "description": "| The time after which to send the client a message about being late. Specified in seconds." }, "delayedCounterDelay": { "type": "integer", "description": "| The time after which to enable the counter in the calendar. Specified in seconds." }, "confirmationDelay": { "type": "integer", "description": "| The time before the booking when the client receives the first confirmation message. Specified in seconds." }, "confirmationRepetitions": { "type": "integer", "description": "| The number of messages sent to the client for booking confirmation, excluding the first." }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| The interval between confirmation messages. Specified in seconds." }, "confirmationCounterDelay": { "type": "integer", "description": "| The time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds." } }, "required": [ "fields", "name", "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a resource (detailed description) ||" }, "name": { "type": "string", "description": "| The name of the resource ||" }, "description": { "type": "string", "description": "| The description of the resource." }, "typeId": { "type": "integer", "description": "| The identifier of the resource type." }, "isMain": { "type": "string", "description": "| How to display the resource. Possible values:" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| The type of the booking notification message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic confirmation of the booking. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| The type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| The type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Feedback request. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| The type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| The type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| The delay after which the client receives a booking message. Specified in seconds." }, "reminderDelay": { "type": "integer", "description": "| The time before the booking when the client receives a reminder. Specified in seconds." }, "delayedDelay": { "type": "integer", "description": "| The time after which to send the client a message about being late. Specified in seconds." }, "delayedCounterDelay": { "type": "integer", "description": "| The time after which to enable the counter in the calendar. Specified in seconds." }, "confirmationDelay": { "type": "integer", "description": "| The time before the booking when the client receives the first confirmation message. Specified in seconds." }, "confirmationRepetitions": { "type": "integer", "description": "| The number of messages sent to the client for booking confirmation, excluding the first." }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| The interval between confirmation messages. Specified in seconds." }, "confirmationCounterDelay": { "type": "integer", "description": "| The time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds." } }, "required": [ "fields", "name", "typeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.delete": { "post": { "summary": "Delete Resource booking.v1.resource.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.delete` removes a resource.", "operationId": "booking_v1_resource_delete", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/booking-v1-resource-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.get": { "post": { "summary": "Get resource booking.v1.resource.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.get` returns information about a resource by its identifier.", "operationId": "booking_v1_resource_get", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/booking-v1-resource-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.list": { "post": { "summary": "Get the list of resources booking.v1.resource.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.list` returns a list of resources based on a filter. It is an implementation of the listing method for resources.", "operationId": "booking_v1_resource_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/booking-v1-resource-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering the list of resources in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| Object for sorting the list of resources in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "searchQuery": { "type": "string", "description": "| Search query. Searches by substring in the resource name ||" }, "isMain": { "type": "string", "description": "| Filter by resource display setting. Possible values:" }, "typeId": { "type": "integer", "description": "| Identifier of the resource type." }, "name": { "type": "string", "description": "| Name of the resource ||" }, "description": { "type": "string", "description": "| Description of the resource ||" }, "id": { "type": "string", "description": "| Sort by identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering the list of resources in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| Object for sorting the list of resources in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "searchQuery": { "type": "string", "description": "| Search query. Searches by substring in the resource name ||" }, "isMain": { "type": "string", "description": "| Filter by resource display setting. Possible values:" }, "typeId": { "type": "integer", "description": "| Identifier of the resource type." }, "name": { "type": "string", "description": "| Name of the resource ||" }, "description": { "type": "string", "description": "| Description of the resource ||" }, "id": { "type": "string", "description": "| Sort by identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.list": { "post": { "summary": "Get Slot Settings for Resource booking.v1.resource.slots.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.slots.list` returns the configuration of time slots for the specified resource.", "operationId": "booking_v1_resource_slots_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/slots/booking-v1-resource-slots-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.set": { "post": { "summary": "Set Slots for Resource booking.v1.resource.slots.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.slots.set` allows you to set time slots for the specified resource.", "operationId": "booking_v1_resource_slots_set", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/slots/booking-v1-resource-slots-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." }, "slots": { "type": "array", "items": {}, "description": "| An array of objects containing field values for setting time slots (detailed description) ||" }, "from": { "type": "integer", "description": "| The time from which slot booking is available during the day. Value in the range from 0 to 1440. For example, `540` means booking is available from 9:00 AM ||" }, "to": { "type": "integer", "description": "| The end time of the slot in minutes. Value in the range from 0 to 1440, greater than or equal to the value of `from`. For example, `1080` means booking is available until 6:00 PM ||" }, "timezone": { "type": "string", "description": "| The time zone relative to which the slot time is set ||" }, "weekDays": { "type": "array", "items": {}, "description": "| An array of available weekdays for the slot. Possible values:" }, "slotSize": { "type": "integer", "description": "| Duration of the slot in minutes ||" } }, "required": [ "resourceId", "slots", "from", "to", "timezone", "weekDays", "slotSize" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." }, "slots": { "type": "array", "items": {}, "description": "| An array of objects containing field values for setting time slots (detailed description) ||" }, "from": { "type": "integer", "description": "| The time from which slot booking is available during the day. Value in the range from 0 to 1440. For example, `540` means booking is available from 9:00 AM ||" }, "to": { "type": "integer", "description": "| The end time of the slot in minutes. Value in the range from 0 to 1440, greater than or equal to the value of `from`. For example, `1080` means booking is available until 6:00 PM ||" }, "timezone": { "type": "string", "description": "| The time zone relative to which the slot time is set ||" }, "weekDays": { "type": "array", "items": {}, "description": "| An array of available weekdays for the slot. Possible values:" }, "slotSize": { "type": "integer", "description": "| Duration of the slot in minutes ||" } }, "required": [ "resourceId", "slots", "from", "to", "timezone", "weekDays", "slotSize" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.slots.unset": { "post": { "summary": "Remove slots for resource booking.v1.resource.slots.unset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.slots.unset` removes the time slot settings for the specified resource.", "operationId": "booking_v1_resource_slots_unset", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/slots/booking-v1-resource-slots-unset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resource.update": { "post": { "summary": "Update resource booking.v1.resource.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resource.update` updates an existing resource.", "operationId": "booking_v1_resource_update", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/booking-v1-resource-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." }, "fields": { "type": "object", "description": "| An object containing field values to update the resource (detailed description) ||" }, "name": { "type": "string", "description": "| Resource name ||" }, "description": { "type": "string", "description": "| Resource description ||" }, "typeId": { "type": "integer", "description": "| Resource type identifier." }, "isMain": { "type": "string", "description": "| How to display the resource. Possible values:" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| Type of the booking message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic booking confirmation. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| Type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| Type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| Type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| Type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds ||" }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds ||" }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a delay message to the client. Specified in seconds ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds ||" }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds ||" }, "confirmationRepetitions": { "type": "integer", "description": "| Number of messages sent to the client for booking confirmation, excluding the first ||" }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between booking confirmation messages. Specified in seconds ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Resource identifier." }, "fields": { "type": "object", "description": "| An object containing field values to update the resource (detailed description) ||" }, "name": { "type": "string", "description": "| Resource name ||" }, "description": { "type": "string", "description": "| Resource description ||" }, "typeId": { "type": "integer", "description": "| Resource type identifier." }, "isMain": { "type": "string", "description": "| How to display the resource. Possible values:" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| Type of the booking message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic booking confirmation. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| Type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| Type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| Type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| Type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds ||" }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds ||" }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a delay message to the client. Specified in seconds ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds ||" }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds ||" }, "confirmationRepetitions": { "type": "integer", "description": "| Number of messages sent to the client for booking confirmation, excluding the first ||" }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between booking confirmation messages. Specified in seconds ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.add": { "post": { "summary": "Add a New Resource Type booking.v1.resourceType.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resourceType.add` adds a new resource type.", "operationId": "booking_v1_resourceType_add", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/resource-type/booking-v1-resourcetype-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a resource type (detailed description) ||" }, "name": { "type": "string", "description": "| The name of the resource type ||" }, "code": { "type": "string", "description": "| A unique code for the resource type ||" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| The type of message template for the booking. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic confirmation of the booking. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| The type of message template for booking confirmation. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| The type of message template for reminders. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| The type of message template for feedback requests. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| The type of message template for delays. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds." }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds." }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a message about the delay to the client. Specified in seconds." }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds." }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds." }, "confirmationRepetitions": { "type": "integer", "description": "| The number of messages sent to the client for booking confirmation, excluding the first." }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between confirmation messages. Specified in seconds." }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds." } }, "required": [ "fields", "name", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating a resource type (detailed description) ||" }, "name": { "type": "string", "description": "| The name of the resource type ||" }, "code": { "type": "string", "description": "| A unique code for the resource type ||" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| The type of message template for the booking. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic confirmation of the booking. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| The type of message template for booking confirmation. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| The type of message template for reminders. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| The type of message template for feedback requests. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| The type of message template for delays. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds." }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds." }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a message about the delay to the client. Specified in seconds." }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds." }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds." }, "confirmationRepetitions": { "type": "integer", "description": "| The number of messages sent to the client for booking confirmation, excluding the first." }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between confirmation messages. Specified in seconds." }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds." } }, "required": [ "fields", "name", "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.delete": { "post": { "summary": "Delete Resource Type booking.v1.resourceType.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resourceType.delete` removes a resource type.", "operationId": "booking_v1_resourceType_delete", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/resource-type/booking-v1-resourcetype-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.get": { "post": { "summary": "Get Resource Type booking.v1.resourceType.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resourceType.get` returns information about the resource type by its identifier.", "operationId": "booking_v1_resourceType_get", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/resource-type/booking-v1-resourcetype-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.list": { "post": { "summary": "Get a list of resource types booking.v1.resourceType.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resourceType.list` returns a list of resource types based on a filter. It is an implementation of the list method for resource types.", "operationId": "booking_v1_resourceType_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/resource-type/booking-v1-resourcetype-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| An object for filtering the list of resource types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of resource types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "searchQuery": { "type": "string", "description": "| Search query. Searches for a substring in the resource type name ||" }, "moduleId": { "type": "string", "description": "| Resource type module ||" }, "name": { "type": "string", "description": "| Resource type name ||" }, "code": { "type": "string", "description": "| Resource type code ||" }, "id": { "type": "string", "description": "| Sort by identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| An object for filtering the list of resource types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "ORDER": { "type": "object", "description": "| An object for sorting the list of resource types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where" }, "searchQuery": { "type": "string", "description": "| Search query. Searches for a substring in the resource type name ||" }, "moduleId": { "type": "string", "description": "| Resource type module ||" }, "name": { "type": "string", "description": "| Resource type name ||" }, "code": { "type": "string", "description": "| Resource type code ||" }, "id": { "type": "string", "description": "| Sort by identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.resourceType.update": { "post": { "summary": "Update Resource Type booking.v1.resourceType.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.resourceType.update` updates information about an existing resource type.", "operationId": "booking_v1_resourceType_update", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/resource/resource-type/booking-v1-resourcetype-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." }, "fields": { "type": "object", "description": "| An object containing field values to update the resource type (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the resource type ||" }, "code": { "type": "string", "description": "| Code of the resource type ||" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| Type of the booking message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic booking confirmation. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| Type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| Type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| Type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| Type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds ||" }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds ||" }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a delay message to the client. Specified in seconds ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds ||" }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds ||" }, "confirmationRepetitions": { "type": "integer", "description": "| Number of messages sent to the client for booking confirmation, excluding the first one ||" }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between booking confirmation messages. Specified in seconds ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the resource type." }, "fields": { "type": "object", "description": "| An object containing field values to update the resource type (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the resource type ||" }, "code": { "type": "string", "description": "| Code of the resource type ||" }, "isInfoNotificationOn": { "type": "string", "description": "| Message to the client about the booking. Possible values:" }, "templateTypeInfo": { "type": "string", "description": "| Type of the booking message template. Possible values:" }, "isConfirmationNotificationOn": { "type": "string", "description": "| Automatic booking confirmation. Possible values:" }, "templateTypeConfirmation": { "type": "string", "description": "| Type of the confirmation message template. Possible values:" }, "isReminderNotificationOn": { "type": "string", "description": "| Reminder about the booking. Possible values:" }, "templateTypeReminder": { "type": "string", "description": "| Type of the reminder message template. Possible values: `base` ||" }, "isFeedbackNotificationOn": { "type": "string", "description": "| Request for feedback. Possible values:" }, "templateTypeFeedback": { "type": "string", "description": "| Type of the feedback request message template. Possible values:" }, "isDelayedNotificationOn": { "type": "string", "description": "| Reminder when the client is late. Possible values:" }, "templateTypeDelayed": { "type": "string", "description": "| Type of the delay message template. Possible values:" }, "infoDelay": { "type": "integer", "description": "| Delay after which the client receives a booking message. Specified in seconds ||" }, "reminderDelay": { "type": "integer", "description": "| Time before the booking when the client receives a reminder. Specified in seconds ||" }, "delayedDelay": { "type": "integer", "description": "| Time after which to send a delay message to the client. Specified in seconds ||" }, "delayedCounterDelay": { "type": "integer", "description": "| Time after which to enable the counter in the calendar. Specified in seconds ||" }, "confirmationDelay": { "type": "integer", "description": "| Time before the booking when the client receives the first confirmation message. Specified in seconds ||" }, "confirmationRepetitions": { "type": "integer", "description": "| Number of messages sent to the client for booking confirmation, excluding the first one ||" }, "confirmationRepetitionsInterval": { "type": "integer", "description": "| Interval between booking confirmation messages. Specified in seconds ||" }, "confirmationCounterDelay": { "type": "integer", "description": "| Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitList.externalData.list": { "post": { "summary": "Get External Data Links for Waitlist Entry booking.v1.waitList.externalData.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitList.externalData.list` returns links for the specified entry in the waitlist.", "operationId": "booking_v1_waitList_externalData_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.add": { "post": { "summary": "Add to waitlist booking.v1.waitlist.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.add` adds an entry to the waitlist.", "operationId": "booking_v1_waitlist_add", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating an entry in the waitlist (detailed description) ||" }, "note": { "type": "string", "description": "| Note for the waitlist entry." } }, "required": [ "fields", "note" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing field values for creating an entry in the waitlist (detailed description) ||" }, "note": { "type": "string", "description": "| Note for the waitlist entry." } }, "required": [ "fields", "note" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.list": { "post": { "summary": "Get the list of clients for the waitlist booking.v1.waitlist.client.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.client.list` returns a list of clients for the specified entry in the waitlist.", "operationId": "booking_v1_waitlist_client_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/client/booking-v1-waitlist-client-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the entry in the waitlist." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the entry in the waitlist." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.set": { "post": { "summary": "Add Clients to the Waitlist Record in booking.v1.waitlist.client.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.client.set` sets clients for the specified record in the waitlist.", "operationId": "booking_v1_waitlist_client_set", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/client/booking-v1-waitlist-client-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist record." }, "clients": { "type": "array", "items": {}, "description": "| Array of objects containing information about clients (detailed description) ||" }, "id": { "type": "integer", "description": "| Client identifier, can be obtained using the method crm.item.list for contacts and companies ||" }, "type": { "type": "object", "description": "| Client type in the format `{\"module\": \"crm\", \"code\": \"CONTACT\"}`." } }, "required": [ "waitListId", "clients", "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist record." }, "clients": { "type": "array", "items": {}, "description": "| Array of objects containing information about clients (detailed description) ||" }, "id": { "type": "integer", "description": "| Client identifier, can be obtained using the method crm.item.list for contacts and companies ||" }, "type": { "type": "object", "description": "| Client type in the format `{\"module\": \"crm\", \"code\": \"CONTACT\"}`." } }, "required": [ "waitListId", "clients", "id", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.client.unset": { "post": { "summary": "Remove clients from the waitlist entry booking.v1.waitlist.client.unset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.client.unset` removes clients for the specified entry in the waitlist.", "operationId": "booking_v1_waitlist_client_unset", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/client/booking-v1-waitlist-client-unset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.createfrombooking": { "post": { "summary": "Create a waitlist entry from booking using booking.v1.waitlist.createfrombooking", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.createfrombooking` creates a waitlist entry based on an existing booking.", "operationId": "booking_v1_waitlist_createfrombooking", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-createfrombooking.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| The identifier of the booking from which the waitlist entry is created." } }, "required": [ "bookingId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "bookingId": { "type": "integer", "description": "| The identifier of the booking from which the waitlist entry is created." } }, "required": [ "bookingId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.delete": { "post": { "summary": "Delete Entry from the Waitlist booking.v1.waitlist.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.delete` removes an entry from the waitlist.", "operationId": "booking_v1_waitlist_delete", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the entry in the waitlist ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the entry in the waitlist ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.externalData.set": { "post": { "summary": "Set Connections for Recording in the Waitlist booking.v1.waitlist.externalData.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.externalData.set` establishes connections for the specified entry in the waitlist.", "operationId": "booking_v1_waitlist_externalData_set", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." }, "externalData": { "type": "array", "items": {}, "description": "| Array of objects containing objects for binding (detailed description) ||" }, "moduleId": { "type": "string", "description": "| Module identifier, for example `crm` ||" }, "entityTypeId": { "type": "string", "description": "| Object type ID, for example `DEAL` ||" }, "value": { "type": "string", "description": "| Element ID, for example `1` ||" } }, "required": [ "waitListId", "externalData", "moduleId", "entityTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist entry." }, "externalData": { "type": "array", "items": {}, "description": "| Array of objects containing objects for binding (detailed description) ||" }, "moduleId": { "type": "string", "description": "| Module identifier, for example `crm` ||" }, "entityTypeId": { "type": "string", "description": "| Object type ID, for example `DEAL` ||" }, "value": { "type": "string", "description": "| Element ID, for example `1` ||" } }, "required": [ "waitListId", "externalData", "moduleId", "entityTypeId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.externalData.unset": { "post": { "summary": "Remove connections for the waitlist record booking.v1.waitlist.externalData.unset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.externalData.unset` removes connections for the specified record in the waitlist.", "operationId": "booking_v1_waitlist_externalData_unset", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/external-data/booking-v1-waitlist-externaldata-unset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist record." } }, "required": [ "waitListId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "waitListId": { "type": "integer", "description": "| Identifier of the waitlist record." } }, "required": [ "waitListId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.get": { "post": { "summary": "Get a Record from the Waitlist booking.v1.waitlist.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.get` returns information about a waitlist record by its identifier.", "operationId": "booking_v1_waitlist_get", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the waitlist record. Can be obtained from the methods booking.v1.waitlist.add and booking.v1.waitlist.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the waitlist record. Can be obtained from the methods booking.v1.waitlist.add and booking.v1.waitlist.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.list": { "post": { "summary": "Get a list of records from the waitlist booking.v1.waitlist.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.list` returns a list of records from the waitlist based on the filter.", "operationId": "booking_v1_waitlist_list", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| An object for filtering waitlist records." }, "from": { "type": "string", "description": "| Start date of the filtering period in the format `dd.mm.yyyy`, inclusive ||" }, "to": { "type": "string", "description": "| End date of the filtering period in the format `dd.mm.yyyy`, exclusive ||" } }, "required": [ "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| An object for filtering waitlist records." }, "from": { "type": "string", "description": "| Start date of the filtering period in the format `dd.mm.yyyy`, inclusive ||" }, "to": { "type": "string", "description": "| End date of the filtering period in the format `dd.mm.yyyy`, exclusive ||" } }, "required": [ "from", "to" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/booking.v1.waitlist.update": { "post": { "summary": "Update a record in the waitlist booking.v1.waitlist.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `booking.v1.waitlist.update` updates the information of a record in the waitlist.", "operationId": "booking_v1_waitlist_update", "tags": [ "Online Booking" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/booking/waitlist/booking-v1-waitlist-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the waitlist record ||" }, "fields": { "type": "object", "description": "| Object containing field values to update the waitlist record (detailed description) ||" }, "note": { "type": "string", "description": "| Note for the waitlist record ||" } }, "required": [ "id", "fields", "note" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the waitlist record ||" }, "fields": { "type": "object", "description": "| Object containing field values to update the waitlist record (detailed description) ||" }, "note": { "type": "string", "description": "| Note for the waitlist record ||" } }, "required": [ "id", "fields", "note" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "booking" ] } ] } }, "/calendar.accessibility.get": { "post": { "summary": "Get User Availability from calendar.accessibility.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the availability of users from the list.", "operationId": "calendar_accessibility_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-accessibility-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Array of user IDs ||" }, "from": { "type": "string", "format": "date", "description": "| Start date of the period for determining availability in the format `YYYY-MM-DD`." }, "to": { "type": "string", "format": "date", "description": "| End date of the period for determining availability in the format `YYYY-MM-DD`." } }, "required": [ "users", "from", "to" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Array of user IDs ||" }, "from": { "type": "string", "format": "date", "description": "| Start date of the period for determining availability in the format `YYYY-MM-DD`." }, "to": { "type": "string", "format": "date", "description": "| End date of the period for determining availability in the format `YYYY-MM-DD`." } }, "required": [ "users", "from", "to" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.add": { "post": { "summary": "Add Event calendar.event.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new event to the calendar.", "operationId": "calendar_event_add", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "from_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `from` parameter ||" }, "to_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `to` parameter ||" }, "section": { "type": "integer", "description": "| Calendar identifier." }, "auto_detect_section": { "type": "string", "description": "| Auto-detection mode for the section." }, "name": { "type": "string", "description": "| Event name ||" }, "skip_time": { "type": "string", "description": "| Pass the date value without time in the `from` and `to` parameters. Possible values:" }, "timezone_from": { "type": "string", "description": "| Timezone of the event start date and time. Default is the current user's timezone." }, "timezone_to": { "type": "string", "description": "| Timezone of the event end date and time. Default value is the current user's timezone." }, "description": { "type": "string", "description": "| Event description ||" }, "color": { "type": "string", "description": "| Background color of the event." }, "text_color": { "type": "string", "description": "| Text color of the event." }, "accessibility": { "type": "string", "description": "| Availability during the event time:" }, "importance": { "type": "string", "description": "| Event importance:" }, "private_event": { "type": "string", "description": "| Mark indicating that the event is private. Possible values:" }, "rrule": { "type": "object", "description": "| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below" }, "is_meeting": { "type": "string", "description": "| Indicator of a meeting with event participants. Possible values:" }, "location": { "type": "string", "description": "| Venue ||" }, "remind": { "type": "array", "items": {}, "description": "| Array of objects describing reminders for the event. The structure is described below ||" }, "attendees": { "type": "array", "items": {}, "description": "| List of identifiers of event participants. This field is mandatory if `is_meeting` = `Y` ||" }, "host": { "type": "integer", "description": "| Identifier of the event organizer. This field is mandatory if `is_meeting` = `Y` ||" }, "meeting": { "type": "object", "description": "| Object with meeting parameters. The structure is described below ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:" }, "FREQ": { "type": "string", "description": "| Recurrence frequency" }, "COUNT": { "type": "integer", "description": "| Number of recurrences ||" }, "INTERVAL": { "type": "integer", "description": "| Interval between recurrences ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| End date of recurrences ||" }, "count": { "type": "integer", "description": "| Numerical value of the time interval ||" }, "notify": { "type": "boolean", "description": "| Flag for notification of confirmation or refusal by participants ||" }, "reinvite": { "type": "boolean", "description": "| Flag for requesting re-confirmation of participation when editing the event ||" }, "allow_invite": { "type": "boolean", "description": "| Flag for allowing participants to invite others to the event ||" }, "hide_guests": { "type": "boolean", "description": "| Flag for hiding the list of participants ||" } }, "required": [ "type", "ownerId", "section", "name", "attendees", "host" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "from_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `from` parameter ||" }, "to_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `to` parameter ||" }, "section": { "type": "integer", "description": "| Calendar identifier." }, "auto_detect_section": { "type": "string", "description": "| Auto-detection mode for the section." }, "name": { "type": "string", "description": "| Event name ||" }, "skip_time": { "type": "string", "description": "| Pass the date value without time in the `from` and `to` parameters. Possible values:" }, "timezone_from": { "type": "string", "description": "| Timezone of the event start date and time. Default is the current user's timezone." }, "timezone_to": { "type": "string", "description": "| Timezone of the event end date and time. Default value is the current user's timezone." }, "description": { "type": "string", "description": "| Event description ||" }, "color": { "type": "string", "description": "| Background color of the event." }, "text_color": { "type": "string", "description": "| Text color of the event." }, "accessibility": { "type": "string", "description": "| Availability during the event time:" }, "importance": { "type": "string", "description": "| Event importance:" }, "private_event": { "type": "string", "description": "| Mark indicating that the event is private. Possible values:" }, "rrule": { "type": "object", "description": "| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below" }, "is_meeting": { "type": "string", "description": "| Indicator of a meeting with event participants. Possible values:" }, "location": { "type": "string", "description": "| Venue ||" }, "remind": { "type": "array", "items": {}, "description": "| Array of objects describing reminders for the event. The structure is described below ||" }, "attendees": { "type": "array", "items": {}, "description": "| List of identifiers of event participants. This field is mandatory if `is_meeting` = `Y` ||" }, "host": { "type": "integer", "description": "| Identifier of the event organizer. This field is mandatory if `is_meeting` = `Y` ||" }, "meeting": { "type": "object", "description": "| Object with meeting parameters. The structure is described below ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:" }, "FREQ": { "type": "string", "description": "| Recurrence frequency" }, "COUNT": { "type": "integer", "description": "| Number of recurrences ||" }, "INTERVAL": { "type": "integer", "description": "| Interval between recurrences ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| End date of recurrences ||" }, "count": { "type": "integer", "description": "| Numerical value of the time interval ||" }, "notify": { "type": "boolean", "description": "| Flag for notification of confirmation or refusal by participants ||" }, "reinvite": { "type": "boolean", "description": "| Flag for requesting re-confirmation of participation when editing the event ||" }, "allow_invite": { "type": "boolean", "description": "| Flag for allowing participants to invite others to the event ||" }, "hide_guests": { "type": "boolean", "description": "| Flag for hiding the list of participants ||" } }, "required": [ "type", "ownerId", "section", "name", "attendees", "host" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.delete": { "post": { "summary": "Delete Event calendar.event.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an event.", "operationId": "calendar_event_delete", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the event." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the event." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.get": { "post": { "summary": "Get Calendar Events List calendar.event.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of calendar events.", "operationId": "calendar_event_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "from": { "type": "string", "format": "date", "description": "| Start date for the selection." }, "to": { "type": "string", "format": "date", "description": "| End date for the selection." }, "section": { "type": "array", "items": {}, "description": "| Array of calendar identifiers ||" } }, "required": [ "type", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "from": { "type": "string", "format": "date", "description": "| Start date for the selection." }, "to": { "type": "string", "format": "date", "description": "| End date for the selection." }, "section": { "type": "array", "items": {}, "description": "| Array of calendar identifiers ||" } }, "required": [ "type", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.get.nearest": { "post": { "summary": "Get a list of upcoming events calendar.event.get.nearest", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of upcoming events.", "operationId": "calendar_event_get_nearest", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get-nearest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "days": { "type": "integer", "description": "| Number of days to retrieve. Default is `60` ||" }, "forCurrentUser": { "type": "boolean", "description": "| Output the list of events for the current user. Default is `true` ||" }, "maxEventsCount": { "type": "integer", "description": "| Maximum number of events to display ||" }, "detailUrl": { "type": "string", "description": "| URL link to the calendar ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "days": { "type": "integer", "description": "| Number of days to retrieve. Default is `60` ||" }, "forCurrentUser": { "type": "boolean", "description": "| Output the list of events for the current user. Default is `true` ||" }, "maxEventsCount": { "type": "integer", "description": "| Maximum number of events to display ||" }, "detailUrl": { "type": "string", "description": "| URL link to the calendar ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.getbyid": { "post": { "summary": "Get Event by ID calendar.event.getbyid", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a calendar event by its identifier.", "operationId": "calendar_event_getbyid", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-get-by-id.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the event." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the event." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.event.update": { "post": { "summary": "Update Event calendar.event.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing event.", "operationId": "calendar_event_update", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-event-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Event identifier." }, "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Calendar owner identifier." }, "from_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `from` parameter. ||" }, "to_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `to` parameter. ||" }, "section": { "type": "integer", "description": "| Calendar identifier. ||" }, "name": { "type": "string", "description": "| Event name. ||" }, "skip_time": { "type": "string", "description": "| Pass the date value without time in the `from` and `to` parameters. Possible values:" }, "timezone_from": { "type": "string", "description": "| Timezone of the start date and time of the event. Default is the current user's timezone." }, "timezone_to": { "type": "string", "description": "| Timezone of the end date and time of the event. Default value is the current user's timezone." }, "description": { "type": "string", "description": "| Event description. ||" }, "color": { "type": "string", "description": "| Background color of the event." }, "text_color": { "type": "string", "description": "| Text color of the event." }, "accessibility": { "type": "string", "description": "| Availability during the event time:" }, "importance": { "type": "string", "description": "| Event importance:" }, "private_event": { "type": "string", "description": "| Mark indicating that the event is private. Possible values:" }, "recurrence_mode": { "type": "string", "description": "| Parameter for partial editing of a recurring event. Possible values:" }, "current_date_from": { "type": "string", "format": "date", "description": "| Date of the current event for partial editing of a recurring event." }, "rrule": { "type": "object", "description": "| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below. ||" }, "is_meeting": { "type": "string", "description": "| Indicator of a meeting with event participants. Possible values:" }, "location": { "type": "string", "description": "| Location. ||" }, "remind": { "type": "array", "items": {}, "description": "| Array of objects describing reminders for the event. The structure is described below. ||" }, "attendees": { "type": "array", "items": {}, "description": "| List of participant identifiers for the event. This field is required if `is_meeting` = `Y`. ||" }, "host": { "type": "string", "description": "| Identifier of the event organizer. This field is required if `is_meeting` = `Y`. ||" }, "meeting": { "type": "object", "description": "| Object with meeting parameters. The structure is described below. ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:" }, "FREQ": { "type": "string", "description": "| Recurrence frequency" }, "COUNT": { "type": "integer", "description": "| Number of recurrences. ||" }, "INTERVAL": { "type": "integer", "description": "| Interval between recurrences. ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| End date of recurrences. ||" }, "count": { "type": "integer", "description": "| Numerical value of the time interval. ||" }, "notify": { "type": "boolean", "description": "| Flag for notification of confirmation or refusal from participants. ||" }, "reinvite": { "type": "boolean", "description": "| Flag for requesting re-confirmation of participation when editing the event. ||" }, "allow_invite": { "type": "boolean", "description": "| Flag allowing participants to invite others to the event. ||" }, "hide_guests": { "type": "boolean", "description": "| Flag for hiding the list of participants. ||" } }, "required": [ "id", "type", "ownerId", "name", "attendees", "host" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Event identifier." }, "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Calendar owner identifier." }, "from_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `from` parameter. ||" }, "to_ts": { "type": "integer", "description": "| Date and time in timestamp format. Can be used instead of the `to` parameter. ||" }, "section": { "type": "integer", "description": "| Calendar identifier. ||" }, "name": { "type": "string", "description": "| Event name. ||" }, "skip_time": { "type": "string", "description": "| Pass the date value without time in the `from` and `to` parameters. Possible values:" }, "timezone_from": { "type": "string", "description": "| Timezone of the start date and time of the event. Default is the current user's timezone." }, "timezone_to": { "type": "string", "description": "| Timezone of the end date and time of the event. Default value is the current user's timezone." }, "description": { "type": "string", "description": "| Event description. ||" }, "color": { "type": "string", "description": "| Background color of the event." }, "text_color": { "type": "string", "description": "| Text color of the event." }, "accessibility": { "type": "string", "description": "| Availability during the event time:" }, "importance": { "type": "string", "description": "| Event importance:" }, "private_event": { "type": "string", "description": "| Mark indicating that the event is private. Possible values:" }, "recurrence_mode": { "type": "string", "description": "| Parameter for partial editing of a recurring event. Possible values:" }, "current_date_from": { "type": "string", "format": "date", "description": "| Date of the current event for partial editing of a recurring event." }, "rrule": { "type": "object", "description": "| Recurrence of the event in the form of an object according to the iCalendar standard. The structure is described below. ||" }, "is_meeting": { "type": "string", "description": "| Indicator of a meeting with event participants. Possible values:" }, "location": { "type": "string", "description": "| Location. ||" }, "remind": { "type": "array", "items": {}, "description": "| Array of objects describing reminders for the event. The structure is described below. ||" }, "attendees": { "type": "array", "items": {}, "description": "| List of participant identifiers for the event. This field is required if `is_meeting` = `Y`. ||" }, "host": { "type": "string", "description": "| Identifier of the event organizer. This field is required if `is_meeting` = `Y`. ||" }, "meeting": { "type": "object", "description": "| Object with meeting parameters. The structure is described below. ||" }, "crm_fields": { "type": "array", "items": {}, "description": "| Array of CRM object identifiers to link to the event. To link objects, list their identifiers with prefixes:" }, "FREQ": { "type": "string", "description": "| Recurrence frequency" }, "COUNT": { "type": "integer", "description": "| Number of recurrences. ||" }, "INTERVAL": { "type": "integer", "description": "| Interval between recurrences. ||" }, "UNTIL": { "type": "string", "format": "date", "description": "| End date of recurrences. ||" }, "count": { "type": "integer", "description": "| Numerical value of the time interval. ||" }, "notify": { "type": "boolean", "description": "| Flag for notification of confirmation or refusal from participants. ||" }, "reinvite": { "type": "boolean", "description": "| Flag for requesting re-confirmation of participation when editing the event. ||" }, "allow_invite": { "type": "boolean", "description": "| Flag allowing participants to invite others to the event. ||" }, "hide_guests": { "type": "boolean", "description": "| Flag for hiding the list of participants. ||" } }, "required": [ "id", "type", "ownerId", "name", "attendees", "host" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.meeting.status.get": { "post": { "summary": "Get the participation status of the current user in the event calendar.meeting.status.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the participation status of the current user in the event.", "operationId": "calendar_meeting_status_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-meeting-status-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Event identifier." } }, "required": [ "eventId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Event identifier." } }, "required": [ "eventId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.meeting.status.set": { "post": { "summary": "Set Participation Status in Event for Current User calendar.meeting.status.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method sets the participation status in an event for the current user.", "operationId": "calendar_meeting_status_set", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-event/calendar-meeting-status-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Event identifier." }, "status": { "type": "string", "description": "| Participation status in the event. Possible values:" } }, "required": [ "eventId", "status" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "eventId": { "type": "integer", "description": "| Event identifier." }, "status": { "type": "string", "description": "| Participation status in the event. Possible values:" } }, "required": [ "eventId", "status" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.add": { "post": { "summary": "Add a new resource calendar.resource.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new resource.", "operationId": "calendar_resource_add", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/resource/calendar-resource-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Resource name ||" } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Resource name ||" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.booking.list": { "post": { "summary": "Get Resource Bookings by Filter calendar.resource.booking.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves resource bookings based on a filter.", "operationId": "calendar_resource_booking_list", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/resource/calendar-resource-booking-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter fields ||" }, "resourceTypeIdList": { "type": "array", "items": {}, "description": "| List of resource identifiers." }, "from": { "type": "string", "format": "date", "description": "| Start date of the period ||" }, "to": { "type": "string", "format": "date", "description": "| End date of the period ||" }, "resourceIdList": { "type": "array", "items": {}, "description": "| List of resource booking identifiers from the custom field of type `resourcebooking` in leads or deals in CRM." } }, "required": [ "filter", "resourceTypeIdList", "resourceIdList" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter fields ||" }, "resourceTypeIdList": { "type": "array", "items": {}, "description": "| List of resource identifiers." }, "from": { "type": "string", "format": "date", "description": "| Start date of the period ||" }, "to": { "type": "string", "format": "date", "description": "| End date of the period ||" }, "resourceIdList": { "type": "array", "items": {}, "description": "| List of resource booking identifiers from the custom field of type `resourcebooking` in leads or deals in CRM." } }, "required": [ "filter", "resourceTypeIdList", "resourceIdList" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.delete": { "post": { "summary": "Delete Resource calendar.resource.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a resource.", "operationId": "calendar_resource_delete", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/resource/calendar-resource-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "| Resource identifier." } }, "required": [ "resourceId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.list": { "post": { "summary": "Get a list of all resources calendar.resource.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of all resources. No parameters.", "operationId": "calendar_resource_list", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/resource/calendar-resource-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| Array of objects. Each object contains a description of the resource ||" }, "ID": { "type": "string", "description": "| Resource identifier ||" }, "NAME": { "type": "string", "description": "| Resource name ||" }, "CREATED_BY": { "type": "string", "description": "| Identifier of the user who created the resource ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| Array of objects. Each object contains a description of the resource ||" }, "ID": { "type": "string", "description": "| Resource identifier ||" }, "NAME": { "type": "string", "description": "| Resource name ||" }, "CREATED_BY": { "type": "string", "description": "| Identifier of the user who created the resource ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.resource.update": { "post": { "summary": "Update resource calendar.resource.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a resource.", "operationId": "calendar_resource_update", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/resource/calendar-resource-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." }, "name": { "type": "string", "description": "| New name of the resource ||" } }, "required": [ "resourceId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "resourceId": { "type": "integer", "description": "| Resource identifier." }, "name": { "type": "string", "description": "| New name of the resource ||" } }, "required": [ "resourceId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.add": { "post": { "summary": "Add Calendar calendar.section.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new calendar. The system will add a new calendar only for the user who executes the method. An administrator can create calendars for other users.", "operationId": "calendar_section_add", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-section-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type. Possible values:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "name": { "type": "string", "description": "| Calendar name ||" }, "description": { "type": "string", "description": "| Calendar description ||" }, "color": { "type": "string", "description": "| Calendar color ||" }, "text_color": { "type": "string", "description": "| Text color in the calendar ||" }, "export": { "type": "object", "description": "| Object export parameters for the calendar" }, "ALLOW": { "type": "boolean", "description": "| Allow calendar export. Possible values:" }, "SET": { "type": "string", "description": "| Period for export. Possible values:" } }, "required": [ "type", "ownerId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type. Possible values:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." }, "name": { "type": "string", "description": "| Calendar name ||" }, "description": { "type": "string", "description": "| Calendar description ||" }, "color": { "type": "string", "description": "| Calendar color ||" }, "text_color": { "type": "string", "description": "| Text color in the calendar ||" }, "export": { "type": "object", "description": "| Object export parameters for the calendar" }, "ALLOW": { "type": "boolean", "description": "| Allow calendar export. Possible values:" }, "SET": { "type": "string", "description": "| Period for export. Possible values:" } }, "required": [ "type", "ownerId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.delete": { "post": { "summary": "Delete Calendar calendar.section.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a calendar.", "operationId": "calendar_section_delete", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-section-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner ||" }, "id": { "type": "integer", "description": "| Identifier of the calendar ||" } }, "required": [ "type", "ownerId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner ||" }, "id": { "type": "integer", "description": "| Identifier of the calendar ||" } }, "required": [ "type", "ownerId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.get": { "post": { "summary": "Get Calendar List calendar.section.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of calendars.", "operationId": "calendar_section_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." } }, "required": [ "type", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner." } }, "required": [ "type", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.section.update": { "post": { "summary": "Update Calendar calendar.section.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the calendar.", "operationId": "calendar_section_update", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-section-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type. Possible values:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner ||" }, "id": { "type": "string", "description": "| Identifier of the calendar ||" }, "name": { "type": "string", "description": "| Calendar name ||" }, "description": { "type": "string", "description": "| Calendar description ||" }, "color": { "type": "string", "description": "| Calendar color ||" }, "text_color": { "type": "string", "description": "| Text color in the calendar ||" }, "export": { "type": "object", "description": "| Object export parameters for the calendar" }, "ALLOW": { "type": "boolean", "description": "| Allow calendar export ||" }, "SET": { "type": "string", "description": "| Period for which to perform the export. Possible values:" } }, "required": [ "type", "ownerId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Calendar type. Possible values:" }, "ownerId": { "type": "integer", "description": "| Identifier of the calendar owner ||" }, "id": { "type": "string", "description": "| Identifier of the calendar ||" }, "name": { "type": "string", "description": "| Calendar name ||" }, "description": { "type": "string", "description": "| Calendar description ||" }, "color": { "type": "string", "description": "| Calendar color ||" }, "text_color": { "type": "string", "description": "| Text color in the calendar ||" }, "export": { "type": "object", "description": "| Object export parameters for the calendar" }, "ALLOW": { "type": "boolean", "description": "| Allow calendar export ||" }, "SET": { "type": "string", "description": "| Period for which to perform the export. Possible values:" } }, "required": [ "type", "ownerId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.settings.get": { "post": { "summary": "Get main calendar settings calendar.settings.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the main calendar settings. Only an administrator of the account can modify the main settings. No parameters.", "operationId": "calendar_settings_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-settings-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "work_time_start": { "type": "string", "description": "| Start time of the workday ||" }, "work_time_end": { "type": "string", "description": "| End time of the workday ||" }, "year_holidays": { "type": "string", "description": "| List of holidays ||" }, "week_holidays": { "type": "array", "items": {}, "description": "| Array of weekend days ||" }, "week_start": { "type": "string", "description": "| Day the week starts ||" }, "user_name_template": { "type": "string", "description": "| User name template ||" }, "sync_by_push": { "type": "boolean", "description": "| Flag for automatic calendar synchronization via subscription. Push events from Google/Office365 ||" }, "user_show_login": { "type": "boolean", "description": "| Flag for displaying user login ||" }, "path_to_user": { "type": "string", "description": "| Template link to user profile ||" }, "path_to_user_calendar": { "type": "string", "description": "| Template link to view user calendar ||" }, "path_to_group": { "type": "string", "description": "| Template link to view workgroup ||" }, "path_to_group_calendar": { "type": "string", "description": "| Template link to view group calendar ||" }, "path_to_vr": { "type": "string", "description": "| Template link to video conference room ||" }, "path_to_rm": { "type": "string", "description": "| Template link to meeting room ||" }, "rm_iblock_type": { "type": "string", "description": "| Type of infoblock for booking meeting and video conference rooms ||" }, "rm_iblock_id": { "type": "string", "description": "| Identifier of the infoblock for booking meeting rooms ||" }, "dep_manager_sub": { "type": "boolean", "description": "| Flag allowing managers to view subordinates' calendars ||" }, "denied_superpose_types": { "type": "array", "items": {}, "description": "| List of calendar types that cannot be added to favorites ||" }, "pathes_for_sites": { "type": "boolean", "description": "| Sets link templates common for all sites ||" }, "forum_id": { "type": "string", "description": "| Identifier of the forum for comments ||" }, "rm_for_sites": { "type": "boolean", "description": "| Sets meeting room parameters common for all sites ||" }, "path_to_type_company_calendar": { "type": "string", "description": "| Template link to view company calendars ||" }, "path_to_type_location": { "type": "string", "description": "| Template link to view meeting room bookings ||" }, "path_to_type_open_event": { "type": "string", "description": "| Template link to view open event calendar ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "work_time_start": { "type": "string", "description": "| Start time of the workday ||" }, "work_time_end": { "type": "string", "description": "| End time of the workday ||" }, "year_holidays": { "type": "string", "description": "| List of holidays ||" }, "week_holidays": { "type": "array", "items": {}, "description": "| Array of weekend days ||" }, "week_start": { "type": "string", "description": "| Day the week starts ||" }, "user_name_template": { "type": "string", "description": "| User name template ||" }, "sync_by_push": { "type": "boolean", "description": "| Flag for automatic calendar synchronization via subscription. Push events from Google/Office365 ||" }, "user_show_login": { "type": "boolean", "description": "| Flag for displaying user login ||" }, "path_to_user": { "type": "string", "description": "| Template link to user profile ||" }, "path_to_user_calendar": { "type": "string", "description": "| Template link to view user calendar ||" }, "path_to_group": { "type": "string", "description": "| Template link to view workgroup ||" }, "path_to_group_calendar": { "type": "string", "description": "| Template link to view group calendar ||" }, "path_to_vr": { "type": "string", "description": "| Template link to video conference room ||" }, "path_to_rm": { "type": "string", "description": "| Template link to meeting room ||" }, "rm_iblock_type": { "type": "string", "description": "| Type of infoblock for booking meeting and video conference rooms ||" }, "rm_iblock_id": { "type": "string", "description": "| Identifier of the infoblock for booking meeting rooms ||" }, "dep_manager_sub": { "type": "boolean", "description": "| Flag allowing managers to view subordinates' calendars ||" }, "denied_superpose_types": { "type": "array", "items": {}, "description": "| List of calendar types that cannot be added to favorites ||" }, "pathes_for_sites": { "type": "boolean", "description": "| Sets link templates common for all sites ||" }, "forum_id": { "type": "string", "description": "| Identifier of the forum for comments ||" }, "rm_for_sites": { "type": "boolean", "description": "| Sets meeting room parameters common for all sites ||" }, "path_to_type_company_calendar": { "type": "string", "description": "| Template link to view company calendars ||" }, "path_to_type_location": { "type": "string", "description": "| Template link to view meeting room bookings ||" }, "path_to_type_open_event": { "type": "string", "description": "| Template link to view open event calendar ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.user.settings.get": { "post": { "summary": "Get User Calendar Settings calendar.user.settings.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves user calendar settings. No parameters.", "operationId": "calendar_user_settings_get", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-user-settings-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "view": { "type": "string", "description": "| Standard view for the calendar. Possible values:" }, "meetSection": { "type": "string", "description": "| Calendar for invitations ||" }, "crmSection": { "type": "string", "description": "| Calendar for CRM ||" }, "showDeclined": { "type": "boolean", "description": "| Show events where the user declined to participate ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Prevent inviting to an event if the time is busy ||" }, "collapseOffHours": { "type": "string", "description": "| Hide non-working hours in the calendar in weekly and daily views. Possible values:" }, "showWeekNumbers": { "type": "string", "description": "| Show week numbers. Possible values:" }, "showTasks": { "type": "string", "description": "| Display tasks in the calendar. Possible values:" }, "syncTasks": { "type": "string", "description": "| Synchronize task calendar. Possible values:" }, "showCompletedTasks": { "type": "string", "description": "| Display completed tasks. Possible values:" }, "lastUsedSection": { "type": "string", "description": "| Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters." }, "sendFromEmail": { "type": "string", "description": "| E-mail for sending mail invitations ||" }, "defaultSections": { "type": "object", "description": "| Settings for preset calendars." }, "syncPeriodPast": { "type": "string", "description": "| Number of months for synchronization in the past period ||" }, "syncPeriodFuture": { "type": "string", "description": "| Number of months for synchronization in the future period ||" }, "defaultReminders": { "type": "object", "description": "| Object with standard settings for event reminders ||" }, "timezoneName": { "type": "string", "description": "| Calendar timezone ||" }, "timezoneOffsetUTC": { "type": "integer", "description": "| Timezone offset relative to UTC in seconds ||" }, "timezoneDefaultName": { "type": "string", "description": "| If the `timezoneName` parameter is not set, the timezone from the `timezoneOffsetUTC` parameter will be specified here ||" }, "work_time_start": { "type": "string", "description": "| Start time of the workday ||" }, "work_time_end": { "type": "string", "description": "| End time of the workday ||" }, "fullDay": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for all-day events ||" }, "withTime": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for events with specified time ||" }, "type": { "type": "string", "description": "| Time type of the reminder. Possible values:" }, "count": { "type": "integer", "description": "| Numeric value of the time interval ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "view": { "type": "string", "description": "| Standard view for the calendar. Possible values:" }, "meetSection": { "type": "string", "description": "| Calendar for invitations ||" }, "crmSection": { "type": "string", "description": "| Calendar for CRM ||" }, "showDeclined": { "type": "boolean", "description": "| Show events where the user declined to participate ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Prevent inviting to an event if the time is busy ||" }, "collapseOffHours": { "type": "string", "description": "| Hide non-working hours in the calendar in weekly and daily views. Possible values:" }, "showWeekNumbers": { "type": "string", "description": "| Show week numbers. Possible values:" }, "showTasks": { "type": "string", "description": "| Display tasks in the calendar. Possible values:" }, "syncTasks": { "type": "string", "description": "| Synchronize task calendar. Possible values:" }, "showCompletedTasks": { "type": "string", "description": "| Display completed tasks. Possible values:" }, "lastUsedSection": { "type": "string", "description": "| Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters." }, "sendFromEmail": { "type": "string", "description": "| E-mail for sending mail invitations ||" }, "defaultSections": { "type": "object", "description": "| Settings for preset calendars." }, "syncPeriodPast": { "type": "string", "description": "| Number of months for synchronization in the past period ||" }, "syncPeriodFuture": { "type": "string", "description": "| Number of months for synchronization in the future period ||" }, "defaultReminders": { "type": "object", "description": "| Object with standard settings for event reminders ||" }, "timezoneName": { "type": "string", "description": "| Calendar timezone ||" }, "timezoneOffsetUTC": { "type": "integer", "description": "| Timezone offset relative to UTC in seconds ||" }, "timezoneDefaultName": { "type": "string", "description": "| If the `timezoneName` parameter is not set, the timezone from the `timezoneOffsetUTC` parameter will be specified here ||" }, "work_time_start": { "type": "string", "description": "| Start time of the workday ||" }, "work_time_end": { "type": "string", "description": "| End time of the workday ||" }, "fullDay": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for all-day events ||" }, "withTime": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for events with specified time ||" }, "type": { "type": "string", "description": "| Time type of the reminder. Possible values:" }, "count": { "type": "integer", "description": "| Numeric value of the time interval ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/calendar.user.settings.set": { "post": { "summary": "Set User Calendar Settings calendar.user.settings.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method sets user calendar settings for the current user.", "operationId": "calendar_user_settings_set", "tags": [ "Calendar" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/calendar/calendar-user-settings-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "| An object with values for user calendar settings ||" }, "view": { "type": "string", "description": "| Default view for the calendar. Possible values:" }, "meetSection": { "type": "string", "description": "| Calendar for invitations ||" }, "crmSection": { "type": "string", "description": "| Calendar for CRM ||" }, "showDeclined": { "type": "boolean", "description": "| Show events that the user declined to participate in ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Prevent inviting to an event if the time is busy ||" }, "collapseOffHours": { "type": "string", "description": "| Hide non-working hours in the calendar in weekly and daily views. Possible values:" }, "showWeekNumbers": { "type": "string", "description": "| Show week numbers. Possible values:" }, "showTasks": { "type": "string", "description": "| Display tasks in the calendar. Possible values:" }, "syncTasks": { "type": "string", "description": "| Synchronize task calendar. Possible values:" }, "showCompletedTasks": { "type": "string", "description": "| Display completed tasks. Possible values:" }, "lastUsedSection": { "type": "string", "description": "| Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters." }, "sendFromEmail": { "type": "string", "description": "| E-mail for sending mail invitations ||" }, "defaultSections": { "type": "object", "description": "| Settings for preset calendars." }, "syncPeriodPast": { "type": "string", "description": "| Number of months for synchronization in the past period ||" }, "syncPeriodFuture": { "type": "string", "description": "| Number of months for synchronization in the future period ||" }, "defaultReminders": { "type": "object", "description": "| An object with standard event reminder settings ||" }, "fullDay": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for all-day events ||" }, "withTime": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for timed events ||" }, "type": { "type": "string", "description": "| Time type of reminder. Possible values:" }, "count": { "type": "integer", "description": "| Numeric value of the time interval ||" } }, "required": [ "settings" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "| An object with values for user calendar settings ||" }, "view": { "type": "string", "description": "| Default view for the calendar. Possible values:" }, "meetSection": { "type": "string", "description": "| Calendar for invitations ||" }, "crmSection": { "type": "string", "description": "| Calendar for CRM ||" }, "showDeclined": { "type": "boolean", "description": "| Show events that the user declined to participate in ||" }, "denyBusyInvitation": { "type": "boolean", "description": "| Prevent inviting to an event if the time is busy ||" }, "collapseOffHours": { "type": "string", "description": "| Hide non-working hours in the calendar in weekly and daily views. Possible values:" }, "showWeekNumbers": { "type": "string", "description": "| Show week numbers. Possible values:" }, "showTasks": { "type": "string", "description": "| Display tasks in the calendar. Possible values:" }, "syncTasks": { "type": "string", "description": "| Synchronize task calendar. Possible values:" }, "showCompletedTasks": { "type": "string", "description": "| Display completed tasks. Possible values:" }, "lastUsedSection": { "type": "string", "description": "| Identifier of the calendar used when creating events if the calendar identifier is not provided in the parameters." }, "sendFromEmail": { "type": "string", "description": "| E-mail for sending mail invitations ||" }, "defaultSections": { "type": "object", "description": "| Settings for preset calendars." }, "syncPeriodPast": { "type": "string", "description": "| Number of months for synchronization in the past period ||" }, "syncPeriodFuture": { "type": "string", "description": "| Number of months for synchronization in the future period ||" }, "defaultReminders": { "type": "object", "description": "| An object with standard event reminder settings ||" }, "fullDay": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for all-day events ||" }, "withTime": { "type": "array", "items": {}, "description": "| Array of standard reminder settings for timed events ||" }, "type": { "type": "string", "description": "| Time type of reminder. Possible values:" }, "count": { "type": "integer", "description": "| Numeric value of the time interval ||" } }, "required": [ "settings" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "calendar" ] } ] } }, "/catalog.catalog.add": { "post": { "summary": "Add Trade Catalog catalog.catalog.add", "description": "This method adds a trade catalog. The method is used only in the on-premise version.", "operationId": "catalog_catalog_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a trade catalog ||" }, "iblockId": { "type": "integer", "description": "| Identifier of the information block." }, "subscription": { "type": "string", "description": "| Is content being sold? Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "productIblockId": { "type": "string", "description": "| Identifier of the parent information block of the trade catalog. Filled only for the trade catalog of trade offers." }, "skuPropertyId": { "type": "string", "description": "| Identifier of the property that stores the identifier of the parent product. Filled only for the trade catalog of trade offers." } }, "required": [ "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a trade catalog ||" }, "iblockId": { "type": "integer", "description": "| Identifier of the information block." }, "subscription": { "type": "string", "description": "| Is content being sold? Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "productIblockId": { "type": "string", "description": "| Identifier of the parent information block of the trade catalog. Filled only for the trade catalog of trade offers." }, "skuPropertyId": { "type": "string", "description": "| Identifier of the property that stores the identifier of the parent product. Filled only for the trade catalog of trade offers." } }, "required": [ "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.delete": { "post": { "summary": "Delete Trade Catalog catalog.catalog.delete", "description": "This method deletes a trade catalog.", "operationId": "catalog_catalog_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.get": { "post": { "summary": "Get Values of All Fields in the Trade Catalog catalog.catalog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the values of all fields in the trade catalog.", "operationId": "catalog_catalog_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.getFields": { "post": { "summary": "Get Available Fields of the Trade Catalog catalog.catalog.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of the trade catalog. No parameters.", "operationId": "catalog_catalog_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "catalog": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the catalog_catalog object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "catalog": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the catalog_catalog object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.isOffers": { "post": { "summary": "Check if the trade catalog is a variation catalog catalog.catalog.isOffers", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method checks if the trade catalog is a variation catalog.", "operationId": "catalog_catalog_isOffers", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-is-offers.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.list": { "post": { "summary": "Get a list of trade catalogs catalog.catalog.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of trade catalogs.", "operationId": "catalog_catalog_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.catalog.update": { "post": { "summary": "Update Fields of the Trade Catalog catalog.catalog.update", "description": "This method updates the fields of the trade catalog.", "operationId": "catalog_catalog_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/catalog/catalog-catalog-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" }, "fields": { "type": "object", "description": "| Field values for updating the trade catalog ||" }, "subscription": { "type": "string", "description": "| Whether content is being sold. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "productIblockId": { "type": "string", "description": "| Identifier of the parent information block of the trade catalog. Filled only for the trade catalog of trade offers." }, "skuPropertyId": { "type": "string", "description": "| Identifier of the property that stores the identifier of the parent product. Filled only for the trade catalog of trade offers." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the trade catalog ||" }, "fields": { "type": "object", "description": "| Field values for updating the trade catalog ||" }, "subscription": { "type": "string", "description": "| Whether content is being sold. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "productIblockId": { "type": "string", "description": "| Identifier of the parent information block of the trade catalog. Filled only for the trade catalog of trade offers." }, "skuPropertyId": { "type": "string", "description": "| Identifier of the property that stores the identifier of the parent product. Filled only for the trade catalog of trade offers." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.add": { "post": { "summary": "Create Inventory Document catalog.document.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.add` creates a new inventory document.", "operationId": "catalog_document_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Document fields (detailed description) ||" }, "docType": { "type": "string", "maxLength": 1, "description": "| Document type. Possible values:" }, "currency": { "type": "string", "description": "| Document currency in ISO 4217 format, for example `USD`. The value cannot be changed after creation." }, "responsibleId": { "type": "string", "description": "| Identifier of the responsible person ||" }, "siteId": { "type": "string", "maxLength": 1, "description": "| Site code to which the document relates. Default is `s1`." }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Document date in ISO 8601 format ||" }, "title": { "type": "string", "description": "| Document title ||" }, "commentary": { "type": "string", "maxLength": 1, "description": "| Document commentary ||" }, "total": { "type": "number", "format": "double", "description": "| Total amount for the document items. The value is calculated automatically after processing but can be set manually ||" }, "docNumber": { "type": "string", "description": "| Internal document number. If not provided, it is generated automatically ||" }, "createdBy": { "type": "string", "description": "| Identifier of the user who created the document. An administrator can specify any value; by default, it is filled with the current user ||" } }, "required": [ "fields", "docType", "currency", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Document fields (detailed description) ||" }, "docType": { "type": "string", "maxLength": 1, "description": "| Document type. Possible values:" }, "currency": { "type": "string", "description": "| Document currency in ISO 4217 format, for example `USD`. The value cannot be changed after creation." }, "responsibleId": { "type": "string", "description": "| Identifier of the responsible person ||" }, "siteId": { "type": "string", "maxLength": 1, "description": "| Site code to which the document relates. Default is `s1`." }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Document date in ISO 8601 format ||" }, "title": { "type": "string", "description": "| Document title ||" }, "commentary": { "type": "string", "maxLength": 1, "description": "| Document commentary ||" }, "total": { "type": "number", "format": "double", "description": "| Total amount for the document items. The value is calculated automatically after processing but can be set manually ||" }, "docNumber": { "type": "string", "description": "| Internal document number. If not provided, it is generated automatically ||" }, "createdBy": { "type": "string", "description": "| Identifier of the user who created the document. An administrator can specify any value; by default, it is filled with the current user ||" } }, "required": [ "fields", "docType", "currency", "responsibleId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.cancel": { "post": { "summary": "Cancel Document of Inventory Accounting catalog.document.cancel", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.cancel` cancels the conduct of the inventory accounting document: - the document status changes to `C` — canceled, - the inventory balances of goods are updated according to the document's positions.", "operationId": "catalog_document_cancel", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-cancel.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document, which can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document, which can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.cancelList": { "post": { "summary": "Canceling Multiple Documents catalog.document.cancelList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.cancelList` cancels the processing of a group of inventory documents: - the status of the documents is changed to `C` — canceled, - the inventory balances of the goods are updated according to the positions of the documents.", "operationId": "catalog_document_cancelList", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-cancel-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| A list of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| A list of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.conduct": { "post": { "summary": "Conduct Warehouse Accounting Document catalog.document.conduct", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.conduct` conducts a warehouse accounting document: - the document status changes to `Y` — conducted, - the warehouse stock of goods is updated according to the document's items.", "operationId": "catalog_document_conduct", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-conduct.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Document identifier, can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Document identifier, can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.conductList": { "post": { "summary": "Conduct Multiple Warehouse Accounting Documents catalog.document.conductList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.conductList` conducts a group of warehouse accounting documents: - the status of the documents changes to `Y` — conducted, - the warehouse stock of goods is updated according to the document positions.", "operationId": "catalog_document_conductList", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-conduct-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| List of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| List of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.confirm": { "post": { "summary": "Conduct Warehouse Accounting Document catalog.document.confirm", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.document.conduct](../catalog-document-conduct.md). The method `catalog.document.confirm` processes the warehouse accounting document.", "operationId": "catalog_document_confirm", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/outdated/catalog-document-confirm.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.delete": { "post": { "summary": "Delete Inventory Document catalog.document.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.delete` removes an inventory document.", "operationId": "catalog_document_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document, which can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document, which can be obtained using the catalog.document.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.deleteList": { "post": { "summary": "Delete Multiple Inventory Documents catalog.document.deleteList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.deleteList` removes multiple inventory documents. Access permissions are checked for each document in the request.", "operationId": "catalog_document_deleteList", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-delete-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| List of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentIds": { "type": "string", "description": "| List of document identifiers, which can be obtained using the catalog.document.list method ||" } }, "required": [ "documentIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.add": { "post": { "summary": "Add Product to Inventory Document catalog.document.element.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.element.add` adds a product item to the inventory document.", "operationId": "catalog_document_element_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/document-element/catalog-document-element-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields of the added product (detailed description) ||" }, "docId": { "type": "string", "description": "| Identifier of the inventory document, can be obtained using the catalog.document.list method. The document must have a status of `N` — not processed ||" }, "elementId": { "type": "string", "description": "| Identifier of the catalog product. The value can be obtained using the catalog.product.* methods ||" }, "storeFrom": { "type": "string", "description": "| Identifier of the source warehouse, can be obtained using the catalog.store.list method. Used for outgoing documents ||" }, "storeTo": { "type": "string", "description": "| Identifier of the receiving warehouse, can be obtained using the catalog.store.list method. Used for incoming and transfer documents ||" }, "amount": { "type": "number", "format": "double", "description": "| Quantity of the product. The value is specified in the units of the document ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchase price in the document's currency ||" } }, "required": [ "fields", "docId", "elementId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields of the added product (detailed description) ||" }, "docId": { "type": "string", "description": "| Identifier of the inventory document, can be obtained using the catalog.document.list method. The document must have a status of `N` — not processed ||" }, "elementId": { "type": "string", "description": "| Identifier of the catalog product. The value can be obtained using the catalog.product.* methods ||" }, "storeFrom": { "type": "string", "description": "| Identifier of the source warehouse, can be obtained using the catalog.store.list method. Used for outgoing documents ||" }, "storeTo": { "type": "string", "description": "| Identifier of the receiving warehouse, can be obtained using the catalog.store.list method. Used for incoming and transfer documents ||" }, "amount": { "type": "number", "format": "double", "description": "| Quantity of the product. The value is specified in the units of the document ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchase price in the document's currency ||" } }, "required": [ "fields", "docId", "elementId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.delete": { "post": { "summary": "Delete Item from Inventory Document catalog.document.element.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.element.delete` removes an item from the inventory document. The document must be accessible to the user and have a status of `N` — not processed.", "operationId": "catalog_document_element_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/document-element/catalog-document-element-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the item record in the document, can be obtained using the catalog.document.element.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the item record in the document, can be obtained using the catalog.document.element.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.fields": { "post": { "summary": "Get a List of Product Fields for the Warehouse Accounting Document catalog.document.element.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.document.element.getFields](../document-element/catalog-document-element-get-fields.md). The method `catalog.document.element.fields` returns a list of product fields for the warehouse accounting document.", "operationId": "catalog_document_element_fields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/outdated/catalog-document-element-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.getFields": { "post": { "summary": "Get the list of product fields for the inventory document catalog.document.element.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.element.getFields` returns the description of product fields from the inventory document.", "operationId": "catalog_document_element_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/document-element/catalog-document-element-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.list": { "post": { "summary": "Get a list of products in inventory documents catalog.document.element.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.element.list` returns product positions associated with inventory documents. Records are automatically limited by available document types and the user's permissions on warehouses.", "operationId": "catalog_document_element_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/document-element/catalog-document-element-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_document_element that need to be selected ||" }, "filter": { "type": "object", "description": "| An object for filtering selected product records in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected product records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_document_element that need to be selected ||" }, "filter": { "type": "object", "description": "| An object for filtering selected product records in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected product records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.element.update": { "post": { "summary": "Update Product in Inventory Document catalog.document.element.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.element.update` modifies an existing item in the inventory document and returns the updated product data.", "operationId": "catalog_document_element_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/document-element/catalog-document-element-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document product, can be obtained using the catalog.document.element.list method ||" }, "fields": { "type": "object", "description": "| Fields to be modified (detailed description below) ||" }, "storeFrom": { "type": "string", "description": "| Identifier of the source warehouse, can be obtained using the catalog.store.list method. Use for outgoing documents. If the parameter is not provided, the current value will be retained ||" }, "storeTo": { "type": "string", "description": "| Identifier of the destination warehouse, can be obtained using the catalog.store.list method. Suitable for incoming and transfer documents. If the parameter is not provided, the current value will be retained ||" }, "amount": { "type": "number", "format": "double", "description": "| Quantity of the product in the document's accounting units. If the parameter is not provided, the current value will be retained ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchase price in the document's currency. If the parameter is not provided, the current value will be retained ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the document product, can be obtained using the catalog.document.element.list method ||" }, "fields": { "type": "object", "description": "| Fields to be modified (detailed description below) ||" }, "storeFrom": { "type": "string", "description": "| Identifier of the source warehouse, can be obtained using the catalog.store.list method. Use for outgoing documents. If the parameter is not provided, the current value will be retained ||" }, "storeTo": { "type": "string", "description": "| Identifier of the destination warehouse, can be obtained using the catalog.store.list method. Suitable for incoming and transfer documents. If the parameter is not provided, the current value will be retained ||" }, "amount": { "type": "number", "format": "double", "description": "| Quantity of the product in the document's accounting units. If the parameter is not provided, the current value will be retained ||" }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchase price in the document's currency. If the parameter is not provided, the current value will be retained ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.fields": { "post": { "summary": "Get a List of Document Fields catalog.document.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.document.getFields](../catalog-document-get-fields.md). The method `catalog.document.fields` returns a list of document fields.", "operationId": "catalog_document_fields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/outdated/catalog-document-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.getFields": { "post": { "summary": "Get Description of Fields for Inventory Document catalog.document.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.getFields` returns the description of fields for the inventory document.", "operationId": "catalog_document_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.list": { "post": { "summary": "Get a List of Warehouse Accounting Documents catalog.document.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.list` returns a paginated list of warehouse accounting documents. By default, filters are applied to the request, limiting the selection to the available document types and the current user's permissions.", "operationId": "catalog_document_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_document that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected documents in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected documents in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_document that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected documents in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected documents in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.mode.status": { "post": { "summary": "Check the status of inventory management catalog.document.mode.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.mode.status` checks the activity of inventory management.", "operationId": "catalog_document_mode_status", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-mode-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.unconfirm": { "post": { "summary": "Cancel Document Processing catalog.document.unconfirm", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.document.cancel](../catalog-document-cancel.md). The method `catalog.document.unconfirm` cancels the processing of a document.", "operationId": "catalog_document_unconfirm", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/outdated/catalog-document-unconfirm.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.document.update": { "post": { "summary": "Update Warehouse Accounting Document catalog.document.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.document.update` modifies the fields of an existing warehouse accounting document.", "operationId": "catalog_document_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/document/catalog-document-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Document identifier, can be obtained using the catalog.document.list method ||" }, "fields": { "type": "object", "description": "| Document fields (detailed description) ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the responsible person ||" }, "dateModify": { "type": "string", "format": "date-time", "description": "| You can provide your own modification date. Defaults to the current date ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Document date ||" }, "total": { "type": "number", "format": "double", "description": "| Total amount for the document items. Automatically recalculated after modifying the items ||" }, "commentary": { "type": "string", "maxLength": 1, "description": "| Commentary for the document ||" }, "title": { "type": "string", "description": "| Document title ||" }, "docNumber": { "type": "string", "description": "| Internal document number ||" }, "modifiedBy": { "type": "string", "description": "| Identifier of the user who modified the document. An administrator can specify any value; defaults to the current user ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Document identifier, can be obtained using the catalog.document.list method ||" }, "fields": { "type": "object", "description": "| Document fields (detailed description) ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the responsible person ||" }, "dateModify": { "type": "string", "format": "date-time", "description": "| You can provide your own modification date. Defaults to the current date ||" }, "dateDocument": { "type": "string", "format": "date-time", "description": "| Document date ||" }, "total": { "type": "number", "format": "double", "description": "| Total amount for the document items. Automatically recalculated after modifying the items ||" }, "commentary": { "type": "string", "maxLength": 1, "description": "| Commentary for the document ||" }, "title": { "type": "string", "description": "| Document title ||" }, "docNumber": { "type": "string", "description": "| Internal document number ||" }, "modifiedBy": { "type": "string", "description": "| Identifier of the user who modified the document. An administrator can specify any value; defaults to the current user ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.add": { "post": { "summary": "Add Vendor to Inventory Document catalog.documentcontractor.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.documentcontractor.add` creates a binding of a vendor, contact, or company to an inventory document.", "operationId": "catalog_documentcontractor_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/documentcontractor/catalog-documentcontractor-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Binding fields (detailed description) ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Binding fields (detailed description) ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.delete": { "post": { "summary": "Remove Vendor Binding from Document catalog.documentcontractor.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.documentcontractor.delete` removes the vendor from the inventory accounting document.", "operationId": "catalog_documentcontractor_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/documentcontractor/catalog-documentcontractor-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier for the vendor binding to the document. It can be obtained using the method catalog.documentcontractor.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier for the vendor binding to the document. It can be obtained using the method catalog.documentcontractor.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.getFields": { "post": { "summary": "Get Description of Fields for Binding Vendor to Inventory Document catalog.documentcontractor.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.documentcontractor.getFields` returns the description of fields for binding a vendor, contact, or company to an inventory document.", "operationId": "catalog_documentcontractor_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/documentcontractor/catalog-documentcontractor-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.documentcontractor.list": { "post": { "summary": "Get a List of Vendor Bindings to Documents catalog.documentcontractor.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.documentcontractor.list` returns a list of vendor bindings to inventory accounting documents. By default, filters are applied to the request that limit the selection based on the current user's permissions.", "operationId": "catalog_documentcontractor_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/documentcontractor/catalog-documentcontractor-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields from catalog_documentcontractor that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected documents in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields from catalog_documentcontractor that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected documents in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.enum.getRoundTypes": { "post": { "summary": "Get a List of Rounding Types catalog.enum.getRoundTypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.enum.getRoundTypes` returns a list of rounding types available in the catalog.", "operationId": "catalog_enum_getRoundTypes", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/enum/catalog-enum-get-round-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.enum.getStoreDocumentTypes": { "post": { "summary": "Get Store Document Types catalog.enum.getStoreDocumentTypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.enum.getStoreDocumentTypes` returns the types of store accounting documents available for REST.", "operationId": "catalog_enum_getStoreDocumentTypes", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/enum/catalog-enum-get-store-document-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.get": { "post": { "summary": "Get Margin Field Values by ID catalog.extra.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns information about the margin based on its ID.", "operationId": "catalog_extra_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/extra/catalog-extra-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Margin ID ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Margin ID ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.getFields": { "post": { "summary": "Get Fields for catalog.extra.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the fields for markup. No parameters.", "operationId": "catalog_extra_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/extra/catalog-extra-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "extra": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_extra, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "extra": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_extra, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.extra.list": { "post": { "summary": "Get the list of markups catalog.extra.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of markups based on the filter.", "operationId": "catalog_extra_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/extra/catalog-extra-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_extra object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected markups in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected markups in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_extra object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected markups in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected markups in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.add": { "post": { "summary": "Add Measurement Unit catalog.measure.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new measurement unit.", "operationId": "catalog_measure_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new measurement unit ||" }, "code": { "type": "integer", "description": "| Unique code for the measurement unit ||" }, "isDefault": { "type": "string", "description": "| Indicates whether the current measurement unit is used as the default measurement unit for new products. Possible values:" }, "measureTitle": { "type": "string", "description": "| Name of the measurement unit" }, "symbol": { "type": "string", "description": "| Symbol" }, "symbolIntl": { "type": "string", "description": "| International symbol" }, "symbolLetterIntl": { "type": "string", "description": "| International letter code symbol" } }, "required": [ "fields", "code", "measureTitle" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new measurement unit ||" }, "code": { "type": "integer", "description": "| Unique code for the measurement unit ||" }, "isDefault": { "type": "string", "description": "| Indicates whether the current measurement unit is used as the default measurement unit for new products. Possible values:" }, "measureTitle": { "type": "string", "description": "| Name of the measurement unit" }, "symbol": { "type": "string", "description": "| Symbol" }, "symbolIntl": { "type": "string", "description": "| International symbol" }, "symbolLetterIntl": { "type": "string", "description": "| International letter code symbol" } }, "required": [ "fields", "code", "measureTitle" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.delete": { "post": { "summary": "Delete Measurement Unit catalog.measure.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a measurement unit.", "operationId": "catalog_measure_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.get": { "post": { "summary": "Get Information About a Unit of Measurement by ID catalog.measure.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about a unit of measurement by its ID.", "operationId": "catalog_measure_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the unit of measurement ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the unit of measurement ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.getFields": { "post": { "summary": "Get Available Fields of Measurement catalog.measure.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of measurement. No parameters.", "operationId": "catalog_measure_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "measure": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the catalog_measure object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "measure": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the catalog_measure object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.list": { "post": { "summary": "Get the list of measurement units catalog.measure.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of measurement units.", "operationId": "catalog_measure_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.measure.update": { "post": { "summary": "Update Measurement Unit catalog.measure.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the measurement unit.", "operationId": "catalog_measure_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/measure/catalog-measure-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the measurement unit ||" }, "fields": { "type": "object", "description": "| Field values for updating the measurement unit ||" }, "code": { "type": "integer", "description": "| Unique code of the measurement unit ||" }, "isDefault": { "type": "string", "description": "| Whether the current measurement unit is used as the default measurement unit for new products. Possible values:" }, "measureTitle": { "type": "string", "description": "| Name of the measurement unit" }, "symbol": { "type": "string", "description": "| Conditional designation" }, "symbolIntl": { "type": "string", "description": "| International conditional designation" }, "symbolLetterIntl": { "type": "string", "description": "| International code letter designation" } }, "required": [ "Id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the measurement unit ||" }, "fields": { "type": "object", "description": "| Field values for updating the measurement unit ||" }, "code": { "type": "integer", "description": "| Unique code of the measurement unit ||" }, "isDefault": { "type": "string", "description": "| Whether the current measurement unit is used as the default measurement unit for new products. Possible values:" }, "measureTitle": { "type": "string", "description": "| Name of the measurement unit" }, "symbol": { "type": "string", "description": "| Conditional designation" }, "symbolIntl": { "type": "string", "description": "| International conditional designation" }, "symbolLetterIntl": { "type": "string", "description": "| International code letter designation" } }, "required": [ "Id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.add": { "post": { "summary": "Add Product Price catalog.price.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.add` adds a new price for a product.", "operationId": "catalog_price_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new product price (detailed description) ||" }, "productId": { "type": "string", "description": "| Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "catalogGroupId": { "type": "string", "description": "| Price type identifier, can be obtained using the method catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "fields", "productId", "catalogGroupId", "price", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new product price (detailed description) ||" }, "productId": { "type": "string", "description": "| Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "catalogGroupId": { "type": "string", "description": "| Price type identifier, can be obtained using the method catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "fields", "productId", "catalogGroupId", "price", "currency" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.delete": { "post": { "summary": "Delete Product Price catalog.price.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.delete` removes the product price.", "operationId": "catalog_price_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price, can be obtained using the catalog.price.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price, can be obtained using the catalog.price.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.get": { "post": { "summary": "Get Product Price by ID catalog.price.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.get` returns information about the product price by its ID.", "operationId": "catalog_price_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price, can be obtained using the catalog.price.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price, can be obtained using the catalog.price.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.getFields": { "post": { "summary": "Get Price Fields catalog.price.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.getFields` returns the fields of a product's price.", "operationId": "catalog_price_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.list": { "post": { "summary": "Get a List of Prices by Filter catalog.price.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.list` returns a list of product prices based on the filter.", "operationId": "catalog_price_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_price that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected product prices in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected product prices in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_price that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected product prices in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected product prices in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.modify": { "post": { "summary": "Update Product Price Collection catalog.price.modify", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.modify` updates the product price collection. It allows adding, updating, and deleting different product prices in a single request.", "operationId": "catalog_price_modify", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-modify.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing data for modifying prices (detailed description) ||" }, "product": { "type": "object", "description": "| Product data and its prices (detailed description) ||" }, "id": { "type": "string", "description": "| Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "prices": { "type": "array", "items": {}, "description": "| Array of product prices (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type, can be obtained using the method catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "fields", "product", "id", "prices", "catalogGroupId", "price", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing data for modifying prices (detailed description) ||" }, "product": { "type": "object", "description": "| Product data and its prices (detailed description) ||" }, "id": { "type": "string", "description": "| Product identifier, can be obtained using the methods catalog.product.list, catalog.product.offer.list, catalog.product.service.list, catalog.product.sku.list ||" }, "prices": { "type": "array", "items": {}, "description": "| Array of product prices (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type, can be obtained using the method catalog.priceType.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "fields", "product", "id", "prices", "catalogGroupId", "price", "currency" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.price.update": { "post": { "summary": "Update Product Price catalog.price.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.price.update` updates the price of a product.", "operationId": "catalog_price_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price/catalog-price-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price ||" }, "fields": { "type": "object", "description": "| Field values for updating the product price (detailed description) ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "id", "fields", "price", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product price ||" }, "fields": { "type": "object", "description": "| Field values for updating the product price (detailed description) ||" }, "price": { "type": "number", "format": "double", "description": "| Price value ||" }, "currency": { "type": "string", "description": "| Currency identifier, can be obtained using the method crm.currency.list ||" } }, "required": [ "id", "fields", "price", "currency" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.add": { "post": { "summary": "Create Price Type catalog.priceType.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new price type.", "operationId": "catalog_priceType_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new price type (detailed description) ||" }, "name": { "type": "string", "description": "| Code of the price type." }, "base": { "type": "string", "description": "| Indicates whether the price type is base. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting." }, "xmlId": { "type": "string", "description": "| External code." } }, "required": [ "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new price type (detailed description) ||" }, "name": { "type": "string", "description": "| Code of the price type." }, "base": { "type": "string", "description": "| Indicates whether the price type is base. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting." }, "xmlId": { "type": "string", "description": "| External code." } }, "required": [ "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.delete": { "post": { "summary": "Delete Price Type catalog.priceType.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a price type.", "operationId": "catalog_priceType_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.get": { "post": { "summary": "Get Price Type Field Values catalog.priceType.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about the price type by its identifier.", "operationId": "catalog_priceType_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.getFields": { "post": { "summary": "Get Price Type Fields catalog.priceType.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the fields of the price type. No parameters.", "operationId": "catalog_priceType_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "priceType": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_price_type, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "priceType": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_price_type, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.list": { "post": { "summary": "Get a list of price types by filter catalog.priceType.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of price types based on the filter.", "operationId": "catalog_priceType_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_price_type object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected price types in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected price types in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_price_type object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected price types in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected price types in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceType.update": { "post": { "summary": "Update Price Type catalog.priceType.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method modifies the values of the price type fields.", "operationId": "catalog_priceType_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/catalog-price-type-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type ||" }, "fields": { "type": "object", "description": "| Field values to update the price type (detailed description) ||" }, "name": { "type": "string", "description": "| Code of the price type ||" }, "base": { "type": "string", "description": "| Indicates if the price type is base. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "xmlId": { "type": "string", "description": "| External code." } }, "required": [ "id", "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type ||" }, "fields": { "type": "object", "description": "| Field values to update the price type (detailed description) ||" }, "name": { "type": "string", "description": "| Code of the price type ||" }, "base": { "type": "string", "description": "| Indicates if the price type is base. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "xmlId": { "type": "string", "description": "| External code." } }, "required": [ "id", "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.add": { "post": { "summary": "Add Price Type Binding to Customer Group catalog.priceTypeGroup.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.priceTypeGroup.add` adds a price type binding to a customer group.", "operationId": "catalog_priceTypeGroup_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a price type binding to a customer group (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type. Can be obtained using the catalog.priceType.list method ||" }, "groupId": { "type": "integer", "description": "| Identifier of the customer group ||" }, "access": { "type": "string", "maxLength": 1, "description": "| Type of access to the price. Possible values:" } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a price type binding to a customer group (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type. Can be obtained using the catalog.priceType.list method ||" }, "groupId": { "type": "integer", "description": "| Identifier of the customer group ||" }, "access": { "type": "string", "maxLength": 1, "description": "| Type of access to the price. Possible values:" } }, "required": [ "fields", "catalogGroupId", "groupId", "access" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.delete": { "post": { "summary": "Remove Price Type Binding from Customer Group catalog.priceTypeGroup.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.priceTypeGroup.delete` removes the binding of a price type to a customer group by its identifier.", "operationId": "catalog_priceTypeGroup_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type binding to the customer group." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type binding to the customer group." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.getFields": { "post": { "summary": "Get Price Type Group Binding Fields catalog.priceTypeGroup.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.priceTypeGroup.getFields` returns the description of the fields binding price types to customer groups.", "operationId": "catalog_priceTypeGroup_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeGroup.list": { "post": { "summary": "Get a List of Price Type Bindings to Customer Groups catalog.priceTypeGroup.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.priceTypeGroup.list` returns a list of price type bindings to customer groups.", "operationId": "catalog_priceTypeGroup_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-group/catalog-price-type-group-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_price_type_group that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bindings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields from catalog_price_type_group that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bindings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.add": { "post": { "summary": "Add Translation for Price Type Name catalog.priceTypeLang.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new translation for the price type name.", "operationId": "catalog_priceTypeLang_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new translation of the price type name ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type." }, "name": { "type": "string", "description": "| Translation of the price type name ||" }, "lang": { "type": "string", "description": "| Language identifier." } }, "required": [ "fields", "catalogGroupId", "name", "lang" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new translation of the price type name ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type." }, "name": { "type": "string", "description": "| Translation of the price type name ||" }, "lang": { "type": "string", "description": "| Language identifier." } }, "required": [ "fields", "catalogGroupId", "name", "lang" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.delete": { "post": { "summary": "Delete Translation of Price Type Name catalog.priceTypeLang.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the translation of the price type name by its identifier.", "operationId": "catalog_priceTypeLang_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type name translation ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type name translation ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.get": { "post": { "summary": "Get the values of the fields for the price type name translation catalog.priceTypeLang.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about the translation of the price type name by its identifier.", "operationId": "catalog_priceTypeLang_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type name translation ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price type name translation ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.getFields": { "post": { "summary": "Get Fields for Price Type Translation catalog.priceTypeLang.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the fields for translating the price type name. No parameters.", "operationId": "catalog_priceTypeLang_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "priceTypeLang": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_price_type_lang, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "priceTypeLang": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_price_type_lang, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.getLanguages": { "post": { "summary": "Get Available Languages for Translation: catalog.priceTypeLang.getLanguages", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of available languages for translation.", "operationId": "catalog_priceTypeLang_getLanguages", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-get-languages.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.list": { "post": { "summary": "Get a list of translations for price type names by the filter catalog.priceTypeLang.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of translations for price type names.", "operationId": "catalog_priceTypeLang_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected price type name translations in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected price type name translations in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.priceTypeLang.update": { "post": { "summary": "Update the translation of the price type name catalog.priceTypeLang.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the translation of the price type name by its identifier.", "operationId": "catalog_priceTypeLang_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/price-type/price-type-lang/catalog-price-type-lang-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the price type name translation ||" }, "fields": { "type": "object", "description": "| Field values for updating the price type name translation ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type." }, "name": { "type": "string", "description": "| Translation of the price type name ||" }, "lang": { "type": "string", "description": "| Language identifier." } }, "required": [ "Id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the price type name translation ||" }, "fields": { "type": "object", "description": "| Field values for updating the price type name translation ||" }, "catalogGroupId": { "type": "string", "description": "| Identifier of the price type." }, "name": { "type": "string", "description": "| Translation of the price type name ||" }, "lang": { "type": "string", "description": "| Language identifier." } }, "required": [ "Id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.add": { "post": { "summary": "Add Product catalog.product.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a product to the trading catalog.", "operationId": "catalog_product_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new product in the form of a structure:" }, "iblockId": { "type": "string", "description": "| Identifier of the trading catalog information block." }, "name": { "type": "string", "description": "| Product name ||" }, "active": { "type": "string", "description": "| Product activity. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Use unique barcodes for each instance. Values:" }, "canBuyZero": { "type": "string", "description": "| Is it possible to buy the product when out of stock:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement." }, "detailPicture": { "type": "object", "description": "| Detailed picture." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product. Options:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| VAT included in the price:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Unit of time for the payment period:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Extension without placing an order. Values:" }, "propertyN": { "type": "string", "description": "| Value of the product property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new product in the form of a structure:" }, "iblockId": { "type": "string", "description": "| Identifier of the trading catalog information block." }, "name": { "type": "string", "description": "| Product name ||" }, "active": { "type": "string", "description": "| Product activity. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Use unique barcodes for each instance. Values:" }, "canBuyZero": { "type": "string", "description": "| Is it possible to buy the product when out of stock:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement." }, "detailPicture": { "type": "object", "description": "| Detailed picture." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product. Options:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| VAT included in the price:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Unit of time for the payment period:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Extension without placing an order. Values:" }, "propertyN": { "type": "string", "description": "| Value of the product property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.delete": { "post": { "summary": "Delete Product catalog.product.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a product from the trade catalog.", "operationId": "catalog_product_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Product identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Product identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.download": { "post": { "summary": "Download Product Files catalog.product.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method downloads product files from the trade catalog based on the provided parameters.", "operationId": "catalog_product_download", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading product files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the product." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored." } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading product files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the product." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored." } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.get": { "post": { "summary": "Get Product by ID catalog.product.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a product in the trade catalog by its `ID`.", "operationId": "catalog_product_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Product identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Product identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.getFieldsByFilter": { "post": { "summary": "Get Product Fields by Filter catalog.product.getFieldsByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves product fields based on a filter.", "operationId": "catalog_product_getFieldsByFilter", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-get-fields-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all product fields ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all product fields ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.list": { "post": { "summary": "Get a list of products by filter catalog.product.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of products from the trade catalog based on a filter.", "operationId": "catalog_product_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing a list of fields that need to be selected (see the catalog_product object fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected products in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "| Object for sorting selected products in `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}` format." }, "start": { "type": "string", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing a list of fields that need to be selected (see the catalog_product object fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected products in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "| Object for sorting selected products in `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}` format." }, "start": { "type": "string", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.add": { "post": { "summary": "Add Product Variation catalog.product.offer.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a product variation to the trade catalog.", "operationId": "catalog_product_offer_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the product variation ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog for variations." }, "name": { "type": "string", "description": "| Name of the product variation ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Unique barcodes for each instance. Possible values:" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the product variation allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array with all sections to which the product variation is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product variation. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product variation ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product variation ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product variation ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product variation ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode. Possible values:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Time unit of the payment period. Possible values:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Renewal without placing an order. Possible values:" }, "parentId": { "type": "integer", "description": "| Identifier of the parent product." }, "propertyN": { "type": "string", "description": "| Value of the property of the product variation, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the product variation ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog for variations." }, "name": { "type": "string", "description": "| Name of the product variation ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Unique barcodes for each instance. Possible values:" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the product variation allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array with all sections to which the product variation is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product variation. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product variation ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product variation ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product variation ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product variation ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode. Possible values:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Time unit of the payment period. Possible values:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Renewal without placing an order. Possible values:" }, "parentId": { "type": "integer", "description": "| Identifier of the parent product." }, "propertyN": { "type": "string", "description": "| Value of the property of the product variation, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.delete": { "post": { "summary": "Delete Product Variation catalog.product.offer.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a product variation.", "operationId": "catalog_product_offer_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.download": { "post": { "summary": "Download Product Variation Files catalog.product.offer.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method downloads product variation files based on the provided parameters.", "operationId": "catalog_product_offer_download", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading product variation files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the product variation." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading product variation files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the product variation." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.get": { "post": { "summary": "Get Product Variation Field Values catalog.product.offer.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the field values of a product variation by its identifier.", "operationId": "catalog_product_offer_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.getFieldsByFilter": { "post": { "summary": "Get Product Variation Fields by Filter catalog.product.offer.getFieldsByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the fields of a product variation based on the filter.", "operationId": "catalog_product_offer_getFieldsByFilter", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-get-fields-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all fields of the product variation ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog for variations." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all fields of the product variation ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog for variations." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.list": { "post": { "summary": "Get a list of product variations catalog.product.offer.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of product variations based on a filter.", "operationId": "catalog_product_offer_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering selected product variations in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering selected product variations in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.offer.update": { "post": { "summary": "Update Product Variation Fields catalog.product.offer.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the fields of a product variation.", "operationId": "catalog_product_offer_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/offer/catalog-product-offer-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." }, "fields": { "type": "object", "description": "| Values of the fields to update the product variation ||" }, "name": { "type": "string", "description": "| Name of the product variation ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Unique barcodes for each instance. Possible values:" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the product variation allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the variation is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product variation. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product variation ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product variation ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product variation ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product variation ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode. Possible values:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Time unit of the payment period. Possible values:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Renewal without placing an order. Possible values:" }, "parentId": { "type": "object", "description": "| Identifier of the parent product. The value is specified in the format `{value: value, valueId: valueId}`, where `value` — identifier of the parent product, and `valueId` — identifier of the property value." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product variation." }, "fields": { "type": "object", "description": "| Values of the fields to update the product variation ||" }, "name": { "type": "string", "description": "| Name of the product variation ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Unique barcodes for each instance. Possible values:" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the product variation allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the variation is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product variation. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product variation ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product variation ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product variation ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product variation ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode. Possible values:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Time unit of the payment period. Possible values:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Renewal without placing an order. Possible values:" }, "parentId": { "type": "object", "description": "| Identifier of the parent product. The value is specified in the format `{value: value, valueId: valueId}`, where `value` — identifier of the parent product, and `valueId` — identifier of the property value." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.add": { "post": { "summary": "Add Service catalog.product.service.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a service to the trade catalog.", "operationId": "catalog_product_service_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the service ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog information block." }, "name": { "type": "string", "description": "| Name of the service ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the service is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price. Possible values:" }, "propertyN": { "type": "string", "description": "| Value of the service property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the service ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog information block." }, "name": { "type": "string", "description": "| Name of the service ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the service is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price. Possible values:" }, "propertyN": { "type": "string", "description": "| Value of the service property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.delete": { "post": { "summary": "Delete Service catalog.product.service.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a service.", "operationId": "catalog_product_service_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.download": { "post": { "summary": "Download Files for Service catalog.product.service.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method downloads service files based on the provided parameters.", "operationId": "catalog_product_service_download", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading service files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the service." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading service files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the service." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.get": { "post": { "summary": "Get Service Field Values catalog.product.service.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the field values of the service by its identifier.", "operationId": "catalog_product_service_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.getFieldsByFilter": { "post": { "summary": "Get Service Fields by Filter catalog.product.service.getFieldsByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns service fields based on the filter.", "operationId": "catalog_product_service_getFieldsByFilter", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-get-fields-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all service fields ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all service fields ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.list": { "post": { "summary": "Get a list of services catalog.product.service.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of services based on a filter.", "operationId": "catalog_product_service_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering selected services in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering selected services in `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` format." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.service.update": { "post": { "summary": "Update Service Fields catalog.product.service.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the service fields.", "operationId": "catalog_product_service_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/service/catalog-product-service-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." }, "fields": { "type": "object", "description": "| Field values for updating the service ||" }, "name": { "type": "string", "description": "| Name of the service ||" }, "active": { "type": "string", "description": "| Active status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the service is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Whether VAT is included in the price. Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the service." }, "fields": { "type": "object", "description": "| Field values for updating the service ||" }, "name": { "type": "string", "description": "| Name of the service ||" }, "active": { "type": "string", "description": "| Active status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the service is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — file name of the picture with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| Whether VAT is included in the price. Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.add": { "post": { "summary": "Add Parent Product catalog.product.sku.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a parent product to the trade catalog.", "operationId": "catalog_product_sku_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the parent product ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog." }, "name": { "type": "string", "description": "| Name of the parent product ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the parent product allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by whom ||" }, "modifiedBy": { "type": "string", "description": "| Modified by whom ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the parent product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement." }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the parent product. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the parent product." }, "length": { "type": "number", "format": "double", "description": "| Length of the parent product." }, "weight": { "type": "number", "format": "double", "description": "| Weight of the parent product." }, "width": { "type": "number", "format": "double", "description": "| Width of the parent product." }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "propertyN": { "type": "string", "description": "| Value of the property of the parent product, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the parent product ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block of the trade catalog." }, "name": { "type": "string", "description": "| Name of the parent product ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the parent product allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by whom ||" }, "modifiedBy": { "type": "string", "description": "| Modified by whom ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the parent product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement." }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the parent product. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the parent product." }, "length": { "type": "number", "format": "double", "description": "| Length of the parent product." }, "weight": { "type": "number", "format": "double", "description": "| Weight of the parent product." }, "width": { "type": "number", "format": "double", "description": "| Width of the parent product." }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "propertyN": { "type": "string", "description": "| Value of the property of the parent product, where `N` — property identifier. There can be multiple properties." } }, "required": [ "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.delete": { "post": { "summary": "Delete Head Product catalog.product.sku.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the head product.", "operationId": "catalog_product_sku_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the head product." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the head product." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.download": { "post": { "summary": "Download Main Product Files catalog.product.sku.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method downloads main product files based on the provided parameters.", "operationId": "catalog_product_sku_download", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading main product files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the main product." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for downloading main product files ||" }, "fileId": { "type": "integer", "description": "| Identifier of the registered file." }, "productId": { "type": "string", "description": "| Identifier of the main product." }, "fieldName": { "type": "string", "description": "| Name of the field (property or field of the information block element) where the file is stored. Possible values:" } }, "required": [ "fields", "fileId", "productId", "fieldName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.get": { "post": { "summary": "Get the values of the parent product fields catalog.product.sku.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the values of the parent product fields by identifier.", "operationId": "catalog_product_sku_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the parent product." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the parent product." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.getFieldsByFilter": { "post": { "summary": "Get Parent Product Fields by Filter catalog.product.sku.getFieldsByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the fields of the parent product based on the filter.", "operationId": "catalog_product_sku_getFieldsByFilter", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-get-fields-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all fields of the parent product ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Filter to retrieve all fields of the parent product ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." } }, "required": [ "filter", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.list": { "post": { "summary": "Get the list of parent products catalog.product.sku.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of parent products based on the filter.", "operationId": "catalog_product_sku_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected parent products in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected parent products in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.sku.update": { "post": { "summary": "Update the main product fields catalog.product.sku.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the fields of the main product.", "operationId": "catalog_product_sku_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/sku/catalog-product-sku-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the main product." }, "fields": { "type": "object", "description": "| Values of the fields to update the main product ||" }, "name": { "type": "string", "description": "| Name of the main product ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the main product allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the main product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement." }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the main product. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the main product." }, "length": { "type": "number", "format": "double", "description": "| Length of the main product." }, "weight": { "type": "number", "format": "double", "description": "| Weight of the main product." }, "width": { "type": "number", "format": "double", "description": "| Width of the main product." }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the main product." }, "fields": { "type": "object", "description": "| Values of the fields to update the main product ||" }, "name": { "type": "string", "description": "| Name of the main product ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "canBuyZero": { "type": "string", "description": "| Is the purchase of the main product allowed when it is out of stock? Possible values:" }, "createdBy": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the main product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement." }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "detailPicture": { "type": "object", "description": "| Detailed picture. Object in the format `{fileData: [value1, value2]}`, where `value1` — name of the picture file with extension, `value2` — picture in base64 format." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the main product. Possible values:" }, "vatId": { "type": "string", "description": "| VAT identifier." }, "vatIncluded": { "type": "string", "description": "| Is VAT included in the price? Possible values:" }, "height": { "type": "number", "format": "double", "description": "| Height of the main product." }, "length": { "type": "number", "format": "double", "description": "| Length of the main product." }, "weight": { "type": "number", "format": "double", "description": "| Weight of the main product." }, "width": { "type": "number", "format": "double", "description": "| Width of the main product." }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.product.update": { "post": { "summary": "Update Product catalog.product.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a product in the trade catalog.", "operationId": "catalog_product_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product/catalog-product-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the product in the form of a structure:" }, "name": { "type": "string", "description": "| Product name ||" }, "active": { "type": "string", "description": "| Product activity. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Use unique barcodes for each instance. Values:" }, "canBuyZero": { "type": "string", "description": "| Is it possible to buy the product when out of stock:" }, "createdBy": { "type": "string", "description": "| Created by whom ||" }, "modifiedBy": { "type": "string", "description": "| Modified by whom ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement." }, "detailPicture": { "type": "object", "description": "| Detailed picture." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product. Options:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| VAT included in the price:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Unit of time for the payment period:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Extension without placing an order. Values:" }, "propertyN": { "type": "string", "description": "| Value of the product property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the product in the form of a structure:" }, "name": { "type": "string", "description": "| Product name ||" }, "active": { "type": "string", "description": "| Product activity. Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" }, "xmlId": { "type": "string", "description": "| External code ||" }, "barcodeMulti": { "type": "string", "description": "| Use unique barcodes for each instance. Values:" }, "canBuyZero": { "type": "string", "description": "| Is it possible to buy the product when out of stock:" }, "createdBy": { "type": "string", "description": "| Created by whom ||" }, "modifiedBy": { "type": "string", "description": "| Modified by whom ||" }, "dateActiveFrom": { "type": "string", "format": "date-time", "description": "| Start date of activity ||" }, "dateActiveTo": { "type": "string", "format": "date-time", "description": "| End date of activity ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "iblockSectionId": { "type": "string", "description": "| Identifier of the main section of the information block ||" }, "IblockSection": { "type": "array", "items": {}, "description": "| Array of all sections to which the product is linked ||" }, "measure": { "type": "string", "description": "| Unit of measurement ||" }, "previewText": { "type": "string", "description": "| Description for the announcement ||" }, "detailText": { "type": "string", "description": "| Detailed description ||" }, "previewPicture": { "type": "object", "description": "| Picture for the announcement." }, "detailPicture": { "type": "object", "description": "| Detailed picture." }, "previewTextType": { "type": "string", "description": "| Type of description for the announcement. Possible values:" }, "detailTextType": { "type": "string", "description": "| Type of detailed description. Possible values:" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "subscribe": { "type": "string", "description": "| Subscription permission for the product. Options:" }, "vatId": { "type": "string", "description": "| VAT identifier ||" }, "vatIncluded": { "type": "string", "description": "| VAT included in the price:" }, "height": { "type": "number", "format": "double", "description": "| Height of the product ||" }, "length": { "type": "number", "format": "double", "description": "| Length of the product ||" }, "weight": { "type": "number", "format": "double", "description": "| Weight of the product ||" }, "width": { "type": "number", "format": "double", "description": "| Width of the product ||" }, "quantityTrace": { "type": "string", "description": "| Quantity accounting mode:" }, "purchasingCurrency": { "type": "string", "description": "| Currency of the purchasing price." }, "purchasingPrice": { "type": "number", "format": "double", "description": "| Purchasing price." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity." }, "quantityReserved": { "type": "number", "format": "double", "description": "| Reserved quantity." }, "recurSchemeLength": { "type": "integer", "description": "| Length of the payment period." }, "recurSchemeType": { "type": "string", "description": "| Unit of time for the payment period:" }, "trialPriceId": { "type": "integer", "description": "| Product for trial payment." }, "withoutOrder": { "type": "string", "description": "| Extension without placing an order. Values:" }, "propertyN": { "type": "string", "description": "| Value of the product property, where `N` — property identifier. There can be multiple properties." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.add": { "post": { "summary": "Add Image to Product catalog.productImage.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds images to a product, parent product, variation, or service.", "operationId": "catalog_productImage_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-image/catalog-product-image-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding an image (detailed description) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| An array of two elements:" }, "productId": { "type": "string", "description": "\\|" }, "type": { "type": "string", "description": "| Image type:" } }, "required": [ "fields", "fileContent", "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding an image (detailed description) ||" }, "fileContent": { "type": "array", "items": {}, "description": "| An array of two elements:" }, "productId": { "type": "string", "description": "\\|" }, "type": { "type": "string", "description": "| Image type:" } }, "required": [ "fields", "fileContent", "productId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.delete": { "post": { "summary": "Delete Image from Product catalog.productImage.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes an image from a product, parent product, variation, or service.", "operationId": "catalog_productImage_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-image/catalog-product-image-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Identifier of the image ||" } }, "required": [ "productId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Identifier of the image ||" } }, "required": [ "productId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.get": { "post": { "summary": "Get Information About Product Image catalog.productImage.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns information about a specific product image, main product, variation, or service.", "operationId": "catalog_productImage_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-image/catalog-product-image-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Identifier of the image ||" } }, "required": [ "productId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "id": { "type": "string", "description": "| Identifier of the image ||" } }, "required": [ "productId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.getFields": { "post": { "summary": "Get Product Image Fields catalog.productImage.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the available fields for a product image, main product, variation, or service. No parameters.", "operationId": "catalog_productImage_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-image/catalog-product-image-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "productImage": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the field of the catalog_product_image, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "productImage": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the field of the catalog_product_image, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productImage.list": { "post": { "summary": "Get the list of product images catalog.productImage.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of product images, parent product images, variations, or services.", "operationId": "catalog_productImage_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-image/catalog-product-image-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "select": { "type": "array", "items": {}, "description": "| An array with a list of fields to select (see fields of the object catalog_product_image) ||" } }, "required": [ "productId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "description": "\\|" }, "select": { "type": "array", "items": {}, "description": "| An array with a list of fields to select (see fields of the object catalog_product_image) ||" } }, "required": [ "productId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.add": { "post": { "summary": "Add Product Property or Variation catalog.productProperty.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.add` adds a property to a product or variation.", "operationId": "catalog_productProperty_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new property (detailed description) ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog." }, "name": { "type": "string", "description": "| Property name ||" }, "propertyType": { "type": "string", "description": "| Basic type of the property. Allowed values:" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Allowed values:" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "code": { "type": "string", "description": "| Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit ||" }, "defaultValue": { "type": "string", "description": "| Default value of the property ||" }, "userType": { "type": "string", "description": "| Custom type of the property. The value must correspond to the specified `propertyType`." }, "rowCount": { "type": "integer", "description": "| Number of input field rows ||" }, "colCount": { "type": "integer", "description": "| Number of input field columns ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Appearance of the list. Allowed values:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Indicator of multiple values. Allowed values:" }, "xmlId": { "type": "string", "description": "| External identifier of the property ||" }, "fileType": { "type": "string", "description": "| List of file extensions for property type `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Number of fields for entering multiple values ||" }, "linkIblockId": { "type": "string", "description": "| Identifier of the related information block." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Indicator of storing the description of the value. Allowed values:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in search. Allowed values:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in filtering. Allowed values:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Indicator of required value. Allowed values:" }, "hint": { "type": "string", "description": "| Hint for the field ||" }, "userTypeSettings": { "type": "object", "description": "| Settings for the custom type. Only scalar values and nested objects from scalar values are supported ||" } }, "required": [ "fields", "iblockId", "name", "propertyType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new property (detailed description) ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog." }, "name": { "type": "string", "description": "| Property name ||" }, "propertyType": { "type": "string", "description": "| Basic type of the property. Allowed values:" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Allowed values:" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "code": { "type": "string", "description": "| Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit ||" }, "defaultValue": { "type": "string", "description": "| Default value of the property ||" }, "userType": { "type": "string", "description": "| Custom type of the property. The value must correspond to the specified `propertyType`." }, "rowCount": { "type": "integer", "description": "| Number of input field rows ||" }, "colCount": { "type": "integer", "description": "| Number of input field columns ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Appearance of the list. Allowed values:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Indicator of multiple values. Allowed values:" }, "xmlId": { "type": "string", "description": "| External identifier of the property ||" }, "fileType": { "type": "string", "description": "| List of file extensions for property type `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Number of fields for entering multiple values ||" }, "linkIblockId": { "type": "string", "description": "| Identifier of the related information block." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Indicator of storing the description of the value. Allowed values:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in search. Allowed values:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in filtering. Allowed values:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Indicator of required value. Allowed values:" }, "hint": { "type": "string", "description": "| Hint for the field ||" }, "userTypeSettings": { "type": "object", "description": "| Settings for the custom type. Only scalar values and nested objects from scalar values are supported ||" } }, "required": [ "fields", "iblockId", "name", "propertyType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.delete": { "post": { "summary": "Delete product property or variation catalog.productProperty.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.delete` removes a product property or variation.", "operationId": "catalog_productProperty_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.get": { "post": { "summary": "Get Values of Product or Variation Property Fields catalog.productProperty.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.get` returns the values of the product or variation property fields.", "operationId": "catalog_productProperty_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.getFields": { "post": { "summary": "Get Product or Variation Property Fields catalog.productProperty.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.getFields` returns the fields of product or variation properties.", "operationId": "catalog_productProperty_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.list": { "post": { "summary": "Get a list of product properties or variations catalog.productProperty.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.list` returns a list of product properties and variations based on the filter.", "operationId": "catalog_productProperty_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object catalog_product_property)." }, "filter": { "type": "object", "description": "| An object for filtering the selected properties in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object catalog_product_property)." }, "filter": { "type": "object", "description": "| An object for filtering the selected properties in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productProperty.update": { "post": { "summary": "Update Product or Variation Property catalog.productProperty.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productProperty.update` modifies the fields of a product or variation property.", "operationId": "catalog_productProperty_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property/catalog-product-property-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Property identifier." }, "fields": { "type": "object", "description": "| Set of fields to update the property (detailed description) ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog." }, "name": { "type": "string", "description": "| Property name ||" }, "propertyType": { "type": "string", "description": "| Base type of the property. Cannot be changed ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Allowed values:" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "code": { "type": "string", "description": "| Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit ||" }, "defaultValue": { "type": "string", "description": "| Default property value ||" }, "userType": { "type": "string", "description": "| User-defined property type. Cannot be changed ||" }, "rowCount": { "type": "integer", "description": "| Number of input field rows ||" }, "colCount": { "type": "integer", "description": "| Number of input field columns ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Appearance of the list. Allowed values:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Multiple value indicator. Allowed values:" }, "xmlId": { "type": "string", "description": "| External identifier of the property ||" }, "fileType": { "type": "string", "description": "| List of file extensions for property type `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Number of fields for inputting multiple values ||" }, "linkIblockId": { "type": "string", "description": "| Identifier of the related information block." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Indicator of storing the value description. Allowed values:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in search. Allowed values:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in filtering. Allowed values:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Indicator of required value. Allowed values:" }, "hint": { "type": "string", "description": "| Field hint ||" }, "userTypeSettings": { "type": "object", "description": "| Settings for the user-defined type. Only scalar values and nested objects of scalar values are supported." } }, "required": [ "id", "fields", "iblockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Property identifier." }, "fields": { "type": "object", "description": "| Set of fields to update the property (detailed description) ||" }, "iblockId": { "type": "string", "description": "| Identifier of the trade catalog." }, "name": { "type": "string", "description": "| Property name ||" }, "propertyType": { "type": "string", "description": "| Base type of the property. Cannot be changed ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Allowed values:" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "code": { "type": "string", "description": "| Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit ||" }, "defaultValue": { "type": "string", "description": "| Default property value ||" }, "userType": { "type": "string", "description": "| User-defined property type. Cannot be changed ||" }, "rowCount": { "type": "integer", "description": "| Number of input field rows ||" }, "colCount": { "type": "integer", "description": "| Number of input field columns ||" }, "listType": { "type": "string", "maxLength": 1, "description": "| Appearance of the list. Allowed values:" }, "multiple": { "type": "string", "maxLength": 1, "description": "| Multiple value indicator. Allowed values:" }, "xmlId": { "type": "string", "description": "| External identifier of the property ||" }, "fileType": { "type": "string", "description": "| List of file extensions for property type `F` ||" }, "multipleCnt": { "type": "integer", "description": "| Number of fields for inputting multiple values ||" }, "linkIblockId": { "type": "string", "description": "| Identifier of the related information block." }, "withDescription": { "type": "string", "maxLength": 1, "description": "| Indicator of storing the value description. Allowed values:" }, "searchable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in search. Allowed values:" }, "filtrable": { "type": "string", "maxLength": 1, "description": "| Indicator of participation in filtering. Allowed values:" }, "isRequired": { "type": "string", "maxLength": 1, "description": "| Indicator of required value. Allowed values:" }, "hint": { "type": "string", "description": "| Field hint ||" }, "userTypeSettings": { "type": "object", "description": "| Settings for the user-defined type. Only scalar values and nested objects of scalar values are supported." } }, "required": [ "id", "fields", "iblockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.add": { "post": { "summary": "Add Value to List Property catalog.productPropertyEnum.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.add` adds a value to a list property.", "operationId": "catalog_productPropertyEnum_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new list value (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." }, "value": { "type": "string", "description": "| Value of the list item. ||" }, "xmlId": { "type": "string", "description": "| External identifier of the list value. Must be unique within the property. ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Indicator of the default value. Acceptable values:" }, "sort": { "type": "integer", "description": "| Sort index. ||" } }, "required": [ "fields", "propertyId", "value", "xmlId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new list value (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." }, "value": { "type": "string", "description": "| Value of the list item. ||" }, "xmlId": { "type": "string", "description": "| External identifier of the list value. Must be unique within the property. ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Indicator of the default value. Acceptable values:" }, "sort": { "type": "integer", "description": "| Sort index. ||" } }, "required": [ "fields", "propertyId", "value", "xmlId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.delete": { "post": { "summary": "Delete the Value of the List Property catalog.productPropertyEnum.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.delete` removes the value of a list property.", "operationId": "catalog_productPropertyEnum_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.get": { "post": { "summary": "Get the Value of the List Property catalog.productPropertyEnum.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.get` returns the value of a list property by its identifier.", "operationId": "catalog_productPropertyEnum_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.getFields": { "post": { "summary": "Get Fields of List Property Values catalog.productPropertyEnum.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.getFields` returns the description of the fields for list property values.", "operationId": "catalog_productPropertyEnum_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.list": { "post": { "summary": "Get a List of Values for List Properties catalog.productPropertyEnum.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.list` returns a list of values for list properties based on the filter.", "operationId": "catalog_productPropertyEnum_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the object catalog_product_property_enum)." }, "filter": { "type": "object", "description": "| An object for filtering the selected values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the object catalog_product_property_enum)." }, "filter": { "type": "object", "description": "| An object for filtering the selected values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyEnum.update": { "post": { "summary": "Update the Value of the List Property catalog.productPropertyEnum.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyEnum.update` updates the value of a list property.", "operationId": "catalog_productPropertyEnum_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-enum/catalog-product-property-enum-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." }, "fields": { "type": "object", "description": "| Set of fields for the updated list value (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "value": { "type": "string", "description": "| Value of the list item. ||" }, "xmlId": { "type": "string", "description": "| External identifier of the list value. Must be unique within the property. ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Indicator of the default value. Acceptable values:" }, "sort": { "type": "integer", "description": "| Sort index. ||" } }, "required": [ "id", "fields", "propertyId", "value", "xmlId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the list property value." }, "fields": { "type": "object", "description": "| Set of fields for the updated list value (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "value": { "type": "string", "description": "| Value of the list item. ||" }, "xmlId": { "type": "string", "description": "| External identifier of the list value. Must be unique within the property. ||" }, "def": { "type": "string", "maxLength": 1, "description": "| Indicator of the default value. Acceptable values:" }, "sort": { "type": "integer", "description": "| Sort index. ||" } }, "required": [ "id", "fields", "propertyId", "value", "xmlId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.add": { "post": { "summary": "Add Product Property or Variation Parameter catalog.productPropertyFeature.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.add` adds a parameter to a product or variation property.", "operationId": "catalog_productPropertyFeature_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new property parameter (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "moduleId": { "type": "string", "description": "| Identifier of the module to which the property parameter belongs." }, "featureId": { "type": "string", "description": "| Code of the property parameter." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Indicator of the parameter's activity. Acceptable values:" } }, "required": [ "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields for the new property parameter (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "moduleId": { "type": "string", "description": "| Identifier of the module to which the property parameter belongs." }, "featureId": { "type": "string", "description": "| Code of the property parameter." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Indicator of the parameter's activity. Acceptable values:" } }, "required": [ "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.get": { "post": { "summary": "Get Product Property Feature Parameter or Variations catalog.productPropertyFeature.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.get` returns the product property feature parameter or variation by its identifier.", "operationId": "catalog_productPropertyFeature_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the property parameter." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the property parameter." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.getAvailableFeaturesByProperty": { "post": { "summary": "Get Available Product Property Features or Variations catalog.productPropertyFeature.getAvailableFeaturesByProperty", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.getAvailableFeaturesByProperty` returns a list of available parameters for the specified product property or variation.", "operationId": "catalog_productPropertyFeature_getAvailableFeaturesByProperty", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-available-features-by-property.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." } }, "required": [ "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." } }, "required": [ "propertyId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.getFields": { "post": { "summary": "Get Fields of Product Property Features or Variations catalog.productPropertyFeature.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.getFields` returns a description of the fields for product property features or variations.", "operationId": "catalog_productPropertyFeature_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.list": { "post": { "summary": "Get a List of Product Property Feature Parameters or Variations catalog.productPropertyFeature.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.list` returns a list of product property feature parameters and variations based on the filter.", "operationId": "catalog_productPropertyFeature_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the object catalog_product_property_features)." }, "filter": { "type": "object", "description": "| An object for filtering the selected parameters in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected parameters in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the object catalog_product_property_features)." }, "filter": { "type": "object", "description": "| An object for filtering the selected parameters in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected parameters in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertyFeature.update": { "post": { "summary": "Update Product Property or Variation Parameter catalog.productPropertyFeature.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertyFeature.update` updates the parameter of a product or variation property.", "operationId": "catalog_productPropertyFeature_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the property parameter." }, "fields": { "type": "object", "description": "| Set of fields for the updated property parameter (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "moduleId": { "type": "string", "description": "| Identifier of the module to which the property parameter belongs." }, "featureId": { "type": "string", "description": "| Code of the property parameter." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Indicator of the parameter's activity. Acceptable values:" } }, "required": [ "id", "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the property parameter." }, "fields": { "type": "object", "description": "| Set of fields for the updated property parameter (detailed description) ||" }, "propertyId": { "type": "string", "description": "| Identifier of the product or variation property." }, "moduleId": { "type": "string", "description": "| Identifier of the module to which the property parameter belongs." }, "featureId": { "type": "string", "description": "| Code of the property parameter." }, "isEnabled": { "type": "string", "maxLength": 1, "description": "| Indicator of the parameter's activity. Acceptable values:" } }, "required": [ "id", "fields", "propertyId", "moduleId", "featureId", "isEnabled" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.get": { "post": { "summary": "Get Section Settings of Property catalog.productPropertySection.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertySection.get` returns the section settings of a product property or variation by the property ID.", "operationId": "catalog_productPropertySection_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-section/catalog-product-property-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| The identifier of the product property or variation." } }, "required": [ "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| The identifier of the product property or variation." } }, "required": [ "propertyId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.list": { "post": { "summary": "Get a List of Section Settings for catalog.productPropertySection.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. The method `catalog.productPropertySection.list` returns a list of section settings for product properties and variations based on a filter.", "operationId": "catalog_productPropertySection_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-section/catalog-product-property-section-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected settings in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected settings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected settings in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected settings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.productPropertySection.set": { "post": { "summary": "Set Section Settings for Property catalog.productPropertySection.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.productPropertySection.set` sets the section settings for a product property or variation. If there are no records for the section settings of the property, the method creates one. If the record already exists, the method updates it.", "operationId": "catalog_productPropertySection_set", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/product-property-section/catalog-product-property-section-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." }, "fields": { "type": "object", "description": "| Fields for the section settings of the property (detailed description) ||" }, "smartFilter": { "type": "string", "maxLength": 1, "description": "| Whether to show the property in the smart filter. Possible values:" }, "displayType": { "type": "string", "maxLength": 1, "description": "| Type of the property in the smart filter. Possible values:" }, "displayExpanded": { "type": "string", "maxLength": 1, "description": "| Whether to show the property expanded in the filter. Possible values:" }, "filterHint": { "type": "string", "description": "| Hint in the smart filter for visitors ||" } }, "required": [ "propertyId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "| Identifier of the product property or variation." }, "fields": { "type": "object", "description": "| Fields for the section settings of the property (detailed description) ||" }, "smartFilter": { "type": "string", "maxLength": 1, "description": "| Whether to show the property in the smart filter. Possible values:" }, "displayType": { "type": "string", "maxLength": 1, "description": "| Type of the property in the smart filter. Possible values:" }, "displayExpanded": { "type": "string", "maxLength": 1, "description": "| Whether to show the property expanded in the filter. Possible values:" }, "filterHint": { "type": "string", "description": "| Hint in the smart filter for visitors ||" } }, "required": [ "propertyId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.get": { "post": { "summary": "Get Unit of Measure Ratio Field Values catalog.ratio.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the values of the unit of measure ratio fields by identifier.", "operationId": "catalog_ratio_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/ratio/catalog-ratio-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the unit of measure ratio." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the unit of measure ratio." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.getFields": { "post": { "summary": "Get Measurement Unit Ratio Fields catalog.ratio.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of the measurement unit ratio. No parameters.", "operationId": "catalog_ratio_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/ratio/catalog-ratio-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "ratio": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_ratio, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "ratio": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_ratio, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.ratio.list": { "post": { "summary": "Get the list of measurement unit ratios catalog.ratio.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of measurement unit ratios.", "operationId": "catalog_ratio_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/ratio/catalog-ratio-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected measurement unit ratios in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected fields of measurement unit ratios in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected measurement unit ratios in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected fields of measurement unit ratios in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.add": { "post": { "summary": "Create a Price Rounding Rule catalog.roundingRule.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a price rounding rule.", "operationId": "catalog_roundingRule_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new price rounding rule (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Price type ||" }, "price": { "type": "number", "format": "double", "description": "| Minimum price for rounding ||" }, "roundType": { "type": "integer", "description": "| Rounding type. Possible values:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Rounding precision ||" } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new price rounding rule (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Price type ||" }, "price": { "type": "number", "format": "double", "description": "| Minimum price for rounding ||" }, "roundType": { "type": "integer", "description": "| Rounding type. Possible values:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Rounding precision ||" } }, "required": [ "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.delete": { "post": { "summary": "Delete Price Rounding Rule catalog.roundingRule.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a price rounding rule.", "operationId": "catalog_roundingRule_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price rounding rule ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price rounding rule ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.get": { "post": { "summary": "Get Values of the Price Rounding Rule Fields catalog.roundingRule.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about the price rounding rule by its identifier.", "operationId": "catalog_roundingRule_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price rounding rule ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the price rounding rule ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.getFields": { "post": { "summary": "Get Fields of the Price Rounding Rule catalog.roundingRule.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the fields of the price rounding rule. No parameters.", "operationId": "catalog_roundingRule_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "roundingRule": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_rounding_rule, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "roundingRule": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_rounding_rule, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.list": { "post": { "summary": "Get a list of price rounding rules by filter catalog.roundingRule.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of price rounding rules.", "operationId": "catalog_roundingRule_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with a list of fields to select (see fields of the object catalog_rounding_rule)." }, "filter": { "type": "object", "description": "| An object for filtering the selected price rounding rules in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected price rounding rules in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with a list of fields to select (see fields of the object catalog_rounding_rule)." }, "filter": { "type": "object", "description": "| An object for filtering the selected price rounding rules in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected price rounding rules in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.roundingRule.update": { "post": { "summary": "Update Price Rounding Rule catalog.roundingRule.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the price rounding rule.", "operationId": "catalog_roundingRule_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/rounding-rule/catalog-rounding-rule-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the price rounding rule ||" }, "fields": { "type": "object", "description": "| Field values for updating the price rounding rule (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Price type ||" }, "price": { "type": "number", "format": "double", "description": "| Minimum price for rounding ||" }, "roundType": { "type": "integer", "description": "| Rounding type. Possible values:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Rounding precision ||" } }, "required": [ "Id", "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Id": { "type": "string", "description": "| Identifier of the price rounding rule ||" }, "fields": { "type": "object", "description": "| Field values for updating the price rounding rule (detailed description) ||" }, "catalogGroupId": { "type": "string", "description": "| Price type ||" }, "price": { "type": "number", "format": "double", "description": "| Minimum price for rounding ||" }, "roundType": { "type": "integer", "description": "| Rounding type. Possible values:" }, "roundPrecision": { "type": "number", "format": "double", "description": "| Rounding precision ||" } }, "required": [ "Id", "fields", "catalogGroupId", "price", "roundType", "roundPrecision" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.add": { "post": { "summary": "Add a Section to the Catalog catalog.section.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.add` adds a section to the catalog.", "operationId": "catalog_section_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new catalog section ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." }, "iblockSectionId": { "type": "string", "description": "| Identifier of the parent section." }, "name": { "type": "string", "description": "| Name of the catalog section ||" }, "xmlId": { "type": "string", "description": "| External identifier." }, "code": { "type": "string", "description": "| Code of the catalog section. Must be unique ||" }, "sort": { "type": "integer", "description": "| Sorting." }, "active": { "type": "string", "description": "| Indicator of the catalog section's activity:" }, "description": { "type": "string", "description": "| Description ||" }, "descriptionType": { "type": "string", "description": "| Type of description. Available types: `text`, `html` ||" } }, "required": [ "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new catalog section ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." }, "iblockSectionId": { "type": "string", "description": "| Identifier of the parent section." }, "name": { "type": "string", "description": "| Name of the catalog section ||" }, "xmlId": { "type": "string", "description": "| External identifier." }, "code": { "type": "string", "description": "| Code of the catalog section. Must be unique ||" }, "sort": { "type": "integer", "description": "| Sorting." }, "active": { "type": "string", "description": "| Indicator of the catalog section's activity:" }, "description": { "type": "string", "description": "| Description ||" }, "descriptionType": { "type": "string", "description": "| Type of description. Available types: `text`, `html` ||" } }, "required": [ "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.delete": { "post": { "summary": "Delete Catalog Section catalog.section.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.delete` removes a section from the catalog.", "operationId": "catalog_section_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.get": { "post": { "summary": "Get Field Values of the Trade Catalog Section catalog.section.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.get` returns the field values of the trade catalog section by its identifier.", "operationId": "catalog_section_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.getFields": { "post": { "summary": "Get Fields of the Catalog Section catalog.section.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.getFields` returns the available fields of the catalog section. Without parameters.", "operationId": "catalog_section_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "section": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `catalog_section`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "section": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `catalog_section`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.list": { "post": { "summary": "Get a List of Sections in the Trade Catalog catalog.section.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.list` returns a list of sections in the trade catalog.", "operationId": "catalog_section_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the catalog_section object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected catalog sections in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected catalog sections in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the catalog_section object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected catalog sections in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected catalog sections in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.section.update": { "post": { "summary": "Update the catalog section catalog.section.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.section.update` modifies a section of the catalog.", "operationId": "catalog_section_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/section/catalog-section-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" }, "fields": { "type": "object", "description": "| Field values for updating the catalog section ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." }, "iblockSectionId": { "type": "string", "description": "| Identifier of the parent section." }, "name": { "type": "string", "description": "| Name of the catalog section ||" }, "xmlId": { "type": "string", "description": "| External identifier." }, "code": { "type": "string", "description": "| Code of the catalog section. Must be unique ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "active": { "type": "string", "description": "| Indicator of the catalog section's activity:" }, "description": { "type": "string", "description": "| Description of the catalog section ||" }, "descriptionType": { "type": "string", "description": "| Type of description. Available types: `text`, `html` ||" } }, "required": [ "id", "fields", "iblockId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the catalog section ||" }, "fields": { "type": "object", "description": "| Field values for updating the catalog section ||" }, "iblockId": { "type": "string", "description": "| Identifier of the information block." }, "iblockSectionId": { "type": "string", "description": "| Identifier of the parent section." }, "name": { "type": "string", "description": "| Name of the catalog section ||" }, "xmlId": { "type": "string", "description": "| External identifier." }, "code": { "type": "string", "description": "| Code of the catalog section. Must be unique ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "active": { "type": "string", "description": "| Indicator of the catalog section's activity:" }, "description": { "type": "string", "description": "| Description of the catalog section ||" }, "descriptionType": { "type": "string", "description": "| Type of description. Available types: `text`, `html` ||" } }, "required": [ "id", "fields", "iblockId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.add": { "post": { "summary": "Add Inventory catalog.store.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new inventory.", "operationId": "catalog_store_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the inventory (detailed description) ||" }, "address": { "type": "string", "description": "| Inventory address ||" }, "title": { "type": "string", "description": "| Inventory name ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "description": { "type": "string", "description": "| Description ||" }, "gpsN": { "type": "number", "format": "double", "description": "| GPS latitude ||" }, "gpsS": { "type": "number", "format": "double", "description": "| GPS longitude ||" }, "imageId": { "type": "object", "description": "| Image. An object in the format `{fileData: [value1, value2]}`, where:" }, "dateModify": { "type": "string", "format": "date-time", "description": "| Date of modification ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Date of creation ||" }, "userId": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "phone": { "type": "string", "description": "| Phone number ||" }, "schedule": { "type": "string", "description": "| Working hours ||" }, "xmlId": { "type": "string", "description": "| External code." }, "sort": { "type": "integer", "description": "| Sorting." }, "email": { "type": "string", "description": "| E-mail ||" }, "issuingCenter": { "type": "string", "description": "| Is it a pickup point? Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" } }, "required": [ "fields", "address" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding the inventory (detailed description) ||" }, "address": { "type": "string", "description": "| Inventory address ||" }, "title": { "type": "string", "description": "| Inventory name ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "description": { "type": "string", "description": "| Description ||" }, "gpsN": { "type": "number", "format": "double", "description": "| GPS latitude ||" }, "gpsS": { "type": "number", "format": "double", "description": "| GPS longitude ||" }, "imageId": { "type": "object", "description": "| Image. An object in the format `{fileData: [value1, value2]}`, where:" }, "dateModify": { "type": "string", "format": "date-time", "description": "| Date of modification ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Date of creation ||" }, "userId": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "phone": { "type": "string", "description": "| Phone number ||" }, "schedule": { "type": "string", "description": "| Working hours ||" }, "xmlId": { "type": "string", "description": "| External code." }, "sort": { "type": "integer", "description": "| Sorting." }, "email": { "type": "string", "description": "| E-mail ||" }, "issuingCenter": { "type": "string", "description": "| Is it a pickup point? Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" } }, "required": [ "fields", "address" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.delete": { "post": { "summary": "Delete warehouse catalog.store.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a warehouse.", "operationId": "catalog_store_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the warehouse." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the warehouse." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.get": { "post": { "summary": "Get Store Field Values catalog.store.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the field values of a store by its identifier.", "operationId": "catalog_store_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Store identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Store identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.getFields": { "post": { "summary": "Get Available Store Fields catalog.store.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of the store. No parameters.", "operationId": "catalog_store_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "store": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_store, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "store": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object catalog_store, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.list": { "post": { "summary": "Get a list of inventories by filter catalog.store.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of inventories based on the filter.", "operationId": "catalog_store_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_store object)" }, "filter": { "type": "object", "description": "| An object for filtering selected inventories in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected inventories in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_store object)" }, "filter": { "type": "object", "description": "| An object for filtering selected inventories in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected inventories in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.store.update": { "post": { "summary": "Update Warehouse catalog.store.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a warehouse.", "operationId": "catalog_store_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store/catalog-store-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the warehouse." }, "fields": { "type": "object", "description": "| Field values for updating the warehouse (detailed description) ||" }, "address": { "type": "string", "description": "| Address of the warehouse ||" }, "title": { "type": "string", "description": "| Name of the warehouse ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "description": { "type": "string", "description": "| Description ||" }, "gpsN": { "type": "number", "format": "double", "description": "| GPS latitude ||" }, "gpsS": { "type": "number", "format": "double", "description": "| GPS longitude ||" }, "imageId": { "type": "object", "description": "| Image. An object in the format `{fileData: [value1, value2]}`, where:" }, "dateModify": { "type": "string", "format": "date-time", "description": "| Date of modification ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Date of creation ||" }, "userId": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "phone": { "type": "string", "description": "| Phone number ||" }, "schedule": { "type": "string", "description": "| Working hours ||" }, "xmlId": { "type": "string", "description": "| External code." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "email": { "type": "string", "description": "| E-mail ||" }, "issuingCenter": { "type": "string", "description": "| Is it a pickup point? Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the warehouse." }, "fields": { "type": "object", "description": "| Field values for updating the warehouse (detailed description) ||" }, "address": { "type": "string", "description": "| Address of the warehouse ||" }, "title": { "type": "string", "description": "| Name of the warehouse ||" }, "active": { "type": "string", "description": "| Activity status. Possible values:" }, "description": { "type": "string", "description": "| Description ||" }, "gpsN": { "type": "number", "format": "double", "description": "| GPS latitude ||" }, "gpsS": { "type": "number", "format": "double", "description": "| GPS longitude ||" }, "imageId": { "type": "object", "description": "| Image. An object in the format `{fileData: [value1, value2]}`, where:" }, "dateModify": { "type": "string", "format": "date-time", "description": "| Date of modification ||" }, "dateCreate": { "type": "string", "format": "date-time", "description": "| Date of creation ||" }, "userId": { "type": "string", "description": "| Created by ||" }, "modifiedBy": { "type": "string", "description": "| Modified by ||" }, "phone": { "type": "string", "description": "| Phone number ||" }, "schedule": { "type": "string", "description": "| Working hours ||" }, "xmlId": { "type": "string", "description": "| External code." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "email": { "type": "string", "description": "| E-mail ||" }, "issuingCenter": { "type": "string", "description": "| Is it a pickup point? Possible values:" }, "code": { "type": "string", "description": "| Symbolic code ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.get": { "post": { "summary": "Get Product Inventory by ID catalog.storeproduct.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.storeproduct.get` returns information about the product inventory by the record ID.", "operationId": "catalog_storeproduct_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store-product/catalog-store-product-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Record ID of the inventory, can be obtained using the catalog.storeproduct.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Record ID of the inventory, can be obtained using the catalog.storeproduct.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.getFields": { "post": { "summary": "Get Inventory Balances Fields catalog.storeproduct.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.storeproduct.getFields` returns the fields of product inventory balances.", "operationId": "catalog_storeproduct_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store-product/catalog-store-product-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.storeproduct.list": { "post": { "summary": "Get a list of inventory balances by filter catalog.storeproduct.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.storeproduct.list` returns a list of product inventory balances by filter.", "operationId": "catalog_storeproduct_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/store-product/catalog-store-product-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with a list of fields from catalog_storeproduct that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected product inventory balances in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected inventory balances in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with a list of fields from catalog_storeproduct that need to be selected." }, "filter": { "type": "object", "description": "| An object for filtering the selected product inventory balances in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected inventory balances in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.userfield.document.list": { "post": { "summary": "Get a List of Custom Field Values for Inventory Accounting Documents catalog.userfield.document.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.userfield.document.list` returns a paginated list of custom field values for inventory accounting documents.", "operationId": "catalog_userfield_document_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/userfield-document/catalog-userfield-document-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the catalog_userfield_document object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| A sorting object in the format `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "select", "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the catalog_userfield_document object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| A sorting object in the format `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "select", "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.userfield.document.update": { "post": { "summary": "Update User Field Values for Inventory Accounting Documents catalog.userfield.document.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `catalog.userfield.document.update` updates the values of user fields in inventory accounting documents.", "operationId": "catalog_userfield_document_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/userfield-document/catalog-userfield-document-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "description": "| Identifier of the inventory accounting document. The identifier can be obtained using the catalog.document.list method ||" }, "fields": { "type": "object", "description": "| Fields to be updated (detailed description) ||" }, "documentType": { "type": "string", "description": "| Type of the inventory accounting document." }, "fieldN": { "type": "string", "description": "| Value of the user field, where `N` is the identifier of the user field, for example `field287`." } }, "required": [ "documentId", "fields", "documentType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "description": "| Identifier of the inventory accounting document. The identifier can be obtained using the catalog.document.list method ||" }, "fields": { "type": "object", "description": "| Fields to be updated (detailed description) ||" }, "documentType": { "type": "string", "description": "| Type of the inventory accounting document." }, "fieldN": { "type": "string", "description": "| Value of the user field, where `N` is the identifier of the user field, for example `field287`." } }, "required": [ "documentId", "fields", "documentType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.add": { "post": { "summary": "Add VAT Rate catalog.vat.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new VAT rate.", "operationId": "catalog_vat_add", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new VAT rate (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the VAT rate ||" }, "active": { "type": "string", "description": "| Indicator of the VAT rate's activity. Possible values:" }, "rate": { "type": "number", "format": "double", "description": "| Value of the VAT rate ||" }, "sort": { "type": "integer", "description": "| Sorting." } }, "required": [ "fields", "name", "rate" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a new VAT rate (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the VAT rate ||" }, "active": { "type": "string", "description": "| Indicator of the VAT rate's activity. Possible values:" }, "rate": { "type": "number", "format": "double", "description": "| Value of the VAT rate ||" }, "sort": { "type": "integer", "description": "| Sorting." } }, "required": [ "fields", "name", "rate" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.delete": { "post": { "summary": "Delete VAT Rate catalog.vat.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a VAT rate.", "operationId": "catalog_vat_delete", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.get": { "post": { "summary": "Get VAT Rate Field Values catalog.vat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about the VAT rate by its identifier.", "operationId": "catalog_vat_get", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.getFields": { "post": { "summary": "Get VAT Rate Fields catalog.vat.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the fields of the VAT rate. No parameters.", "operationId": "catalog_vat_getFields", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "vat": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value\"}`, where `field` is the identifier of the object" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "vat": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value\"}`, where `field` is the identifier of the object" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.list": { "post": { "summary": "Get a List of VAT Rates by Filter catalog.vat.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of VAT rates based on the filter.", "operationId": "catalog_vat_list", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_vat object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected VAT rates in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected VAT rates in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the catalog_vat object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected VAT rates in the format `{\"field_1\": \"value_1\", ..., \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected VAT rates in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/catalog.vat.update": { "post": { "summary": "Update VAT Rate catalog.vat.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the VAT rate.", "operationId": "catalog_vat_update", "tags": [ "Trade Catalog" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/catalog/vat/catalog-vat-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" }, "fields": { "type": "object", "description": "| Field values for updating the VAT rate (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the VAT rate ||" }, "active": { "type": "string", "description": "| Indicator of the VAT rate's activity. Possible values:" }, "rate": { "type": "number", "format": "double", "description": "| Value of the VAT rate ||" }, "sort": { "type": "integer", "description": "| Sorting" } }, "required": [ "id", "fields", "name", "rate" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the VAT rate ||" }, "fields": { "type": "object", "description": "| Field values for updating the VAT rate (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the VAT rate ||" }, "active": { "type": "string", "description": "| Indicator of the VAT rate's activity. Possible values:" }, "rate": { "type": "number", "format": "double", "description": "| Value of the VAT rate ||" }, "sort": { "type": "integer", "description": "| Sorting" } }, "required": [ "id", "fields", "name", "rate" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "catalog" ] } ] } }, "/crm.activity.add": { "post": { "summary": "Add System Activity crm.activity.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.add](../todo/crm-activity-todo-add.md). The method `crm.activity.add` creates a new system activity.", "operationId": "crm_activity_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| An array of values for the activity fields in the following structure:" }, "Field": { "type": "string", "description": "`type` | Description ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the CRM entity ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Identifier of the CRM object type ||" }, "TYPE_ID": { "type": "string", "description": "| Type of the activity. To get available activity types, use the method crm.enum.activitytype." }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Identifier of the entity associated with the activity ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Description of communication ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Date and time of the activity's deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the activity ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Type of description ||" }, "DIRECTION": { "type": "string", "description": "| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| Time of activity completion | ||" }, "FILES": { "type": "string", "description": "| Files added to the activity ||" }, "LOCATION": { "type": "string", "description": "| Location ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Type of notification ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source, used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the entity in the data source, used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting ||" }, "PRIORITY": { "type": "string", "description": "| Priority ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Additional provider data ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Identifier of the provider group ||" }, "PROVIDER_ID": { "type": "string", "description": "| Identifier of the provider ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Identifier of the provider type, status from the directory ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Additional provider parameters ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Identifier of the user responsible for the activity ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Time when the activity starts ||" }, "STATUS": { "type": "string", "description": "| Status of the activity ||" }, "SUBJECT": { "type": "string", "description": "| Additional description of the activity ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Added files. Deprecated, kept for compatibility ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||" } }, "required": [ "fields", "OWNER_ID", "OWNER_TYPE_ID", "TYPE_ID", "COMMUNICATIONS", "RESPONSIBLE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| An array of values for the activity fields in the following structure:" }, "Field": { "type": "string", "description": "`type` | Description ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the CRM entity ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Identifier of the CRM object type ||" }, "TYPE_ID": { "type": "string", "description": "| Type of the activity. To get available activity types, use the method crm.enum.activitytype." }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Identifier of the entity associated with the activity ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Description of communication ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Date and time of the activity's deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the activity ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Type of description ||" }, "DIRECTION": { "type": "string", "description": "| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| Time of activity completion | ||" }, "FILES": { "type": "string", "description": "| Files added to the activity ||" }, "LOCATION": { "type": "string", "description": "| Location ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Type of notification ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source, used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the entity in the data source, used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting ||" }, "PRIORITY": { "type": "string", "description": "| Priority ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Additional provider data ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Identifier of the provider group ||" }, "PROVIDER_ID": { "type": "string", "description": "| Identifier of the provider ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Identifier of the provider type, status from the directory ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Additional provider parameters ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Identifier of the user responsible for the activity ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Time when the activity starts ||" }, "STATUS": { "type": "string", "description": "| Status of the activity ||" }, "SUBJECT": { "type": "string", "description": "| Additional description of the activity ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Added files. Deprecated, kept for compatibility ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||" } }, "required": [ "fields", "OWNER_ID", "OWNER_TYPE_ID", "TYPE_ID", "COMMUNICATIONS", "RESPONSIBLE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.add": { "post": { "summary": "Add Badge crm.activity.badge.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.add` adds a new badge for a configurable activity.", "operationId": "crm_activity_badge_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" }, "type": { "type": "string", "description": "| Badge type ||" } }, "required": [ "code", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" }, "type": { "type": "string", "description": "| Badge type ||" } }, "required": [ "code", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.delete": { "post": { "summary": "Delete Badge by Code crm.activity.badge.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.delete` removes a badge.", "operationId": "crm_activity_badge_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.get": { "post": { "summary": "Get Badge Information by Code crm.activity.badge.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.get` will return an array containing [badge fields](./index.md#badge-record-fields).", "operationId": "crm_activity_badge_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "code": { "type": "string", "description": "| Badge code, for example `missedCall` ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.badge.list": { "post": { "summary": "Get the list of badges crm.activity.badge.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.list` retrieves a list of available badges. It will return an array containing a list of all registered badges. Each element of the array contains [badge fields](./index.md#badge-record-fields).", "operationId": "crm_activity_badge_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.add": { "post": { "summary": "Add a deal binding to a CRM entity crm.activity.binding.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.add` adds a binding of a deal to a CRM entity. The maximum number of bindings for a single deal is 100 CRM entities.", "operationId": "crm_activity_binding_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" }, "entityTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the deal should be bound, for example `2` for a deal ||" }, "entityId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the deal should be bound, for example `1` ||" } }, "required": [ "activityId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" }, "entityTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the deal should be bound, for example `2` for a deal ||" }, "entityId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the deal should be bound, for example `1` ||" } }, "required": [ "activityId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.delete": { "post": { "summary": "Delete the deal's connection with the CRM entity crm.activity.binding.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.delete` removes the connection of a deal with a CRM entity. If the deal is linked to only one entity, this connection cannot be deleted.", "operationId": "crm_activity_binding_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" }, "entityTypeId": { "type": "integer", "description": "| Integer identifier of the CRM entity type to which the deal connection is being removed, for example `2` for a deal ||" }, "entityId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the deal connection is being removed, for example `1` ||" } }, "required": [ "activityId", "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" }, "entityTypeId": { "type": "integer", "description": "| Integer identifier of the CRM entity type to which the deal connection is being removed, for example `2` for a deal ||" }, "entityId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the deal connection is being removed, for example `1` ||" } }, "required": [ "activityId", "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.list": { "post": { "summary": "Get a list of all bindings for the deal crm.activity.binding.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.list` retrieves a list of all bindings for the deal. The method will return an array, where each element will be an array containing: - `entityTypeId` — integer identifier of the [CRM object type](../../../data-types.md#object_type)", "operationId": "crm_activity_binding_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" } }, "required": [ "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| Integer identifier of the deal in the timeline, for example `999` ||" } }, "required": [ "activityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.binding.move": { "post": { "summary": "Update the Deal's Connection with the CRM Entity crm.activity.binding.move", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.move` updates the connection of a deal with a CRM entity.", "operationId": "crm_activity_binding_move", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-move.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| The identifier of the deal in the timeline, for example, `999` ||" }, "sourceEntityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example, `2` for a deal ||" }, "sourceEntityId": { "type": "integer", "description": "| The identifier of the CRM entity to which the deal is linked, for example, `1` ||" }, "targetEntityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal should be linked, for example, `2` for a deal ||" }, "targetEntityId": { "type": "integer", "description": "| The identifier of the CRM entity to which the deal should be linked, for example, `100` ||" } }, "required": [ "activityId", "sourceEntityTypeId", "sourceEntityId", "targetEntityTypeId", "targetEntityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "activityId": { "type": "integer", "description": "| The identifier of the deal in the timeline, for example, `999` ||" }, "sourceEntityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example, `2` for a deal ||" }, "sourceEntityId": { "type": "integer", "description": "| The identifier of the CRM entity to which the deal is linked, for example, `1` ||" }, "targetEntityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal should be linked, for example, `2` for a deal ||" }, "targetEntityId": { "type": "integer", "description": "| The identifier of the CRM entity to which the deal should be linked, for example, `100` ||" } }, "required": [ "activityId", "sourceEntityTypeId", "sourceEntityId", "targetEntityTypeId", "targetEntityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.communication.fields": { "post": { "summary": "Get Description of Communication crm.activity.communication.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.communication.fields` returns the description of communication for an activity. Communications store phone numbers in calls, email addresses in e-mails, and names in meetings.", "operationId": "crm_activity_communication_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.add": { "post": { "summary": "Add Configurable CRM Activity crm.activity.configurable.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.configurable.add` adds a configurable activity to the timeline. The method can only be called in the context of an [application](https://helpdesk.bitrix24.com/examples/app.zip).", "operationId": "crm_activity_configurable_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM entity type in which the activity is created, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM element in which the activity is created, for example `1` ||" }, "fields": { "type": "array", "items": {}, "description": "| Associative array of values for the activity fields in the following structure:" }, "layout": { "type": "string", "description": "| Associative array of a special structure describing the appearance of the activity in the timeline ||" }, "typeId": { "type": "string", "description": "| Type of the configurable activity. If not specified, it defaults to `CONFIGURABLE`. If specified, the value must correspond to one of the types created by the method crm.activity.type.add with the field `IS_CONFIGURABLE_TYPE` equal to `Y` in the context of the same application ||" }, "completed": { "type": "boolean", "description": "| Flag indicating whether the activity is closed. You can use `Y/N`, `1/0`, `true/false` to set the value ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline for the activity ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| Array of offsets in minutes relative to the deadline, determining when to create ping records for this activity ||" }, "isIncomingChannel": { "type": "boolean", "description": "| Flag indicating whether the activity was created from an incoming channel. You can use `Y/N`, `1/0`, `true/false` to set the value ||" }, "responsibleId": { "type": "integer", "description": "| Responsible person for the activity ||" }, "badgeCode": { "type": "string", "description": "| Code of the badge on the kanban corresponding to the activity ||" }, "originatorId": { "type": "string", "description": "| Identifier of the data source ||" }, "originId": { "type": "string", "description": "| Identifier of the element in the data source ||" } }, "required": [ "ownerTypeId", "ownerId", "fields", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM entity type in which the activity is created, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM element in which the activity is created, for example `1` ||" }, "fields": { "type": "array", "items": {}, "description": "| Associative array of values for the activity fields in the following structure:" }, "layout": { "type": "string", "description": "| Associative array of a special structure describing the appearance of the activity in the timeline ||" }, "typeId": { "type": "string", "description": "| Type of the configurable activity. If not specified, it defaults to `CONFIGURABLE`. If specified, the value must correspond to one of the types created by the method crm.activity.type.add with the field `IS_CONFIGURABLE_TYPE` equal to `Y` in the context of the same application ||" }, "completed": { "type": "boolean", "description": "| Flag indicating whether the activity is closed. You can use `Y/N`, `1/0`, `true/false` to set the value ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline for the activity ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| Array of offsets in minutes relative to the deadline, determining when to create ping records for this activity ||" }, "isIncomingChannel": { "type": "boolean", "description": "| Flag indicating whether the activity was created from an incoming channel. You can use `Y/N`, `1/0`, `true/false` to set the value ||" }, "responsibleId": { "type": "integer", "description": "| Responsible person for the activity ||" }, "badgeCode": { "type": "string", "description": "| Code of the badge on the kanban corresponding to the activity ||" }, "originatorId": { "type": "string", "description": "| Identifier of the data source ||" }, "originId": { "type": "string", "description": "| Identifier of the element in the data source ||" } }, "required": [ "ownerTypeId", "ownerId", "fields", "layout" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.get": { "post": { "summary": "Get Configurable Activity by ID crm.activity.configurable.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.configurable.get` returns information about a configurable activity. The method can only be called in the context of an [application](https://helpdesk.bitrix24.com/examples/app.zip).", "operationId": "crm_activity_configurable_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity, for example `999` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity, for example `999` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.configurable.update": { "post": { "summary": "Update Configurable Activity crm.activity.configurable.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.configurable.update` makes changes to a configurable activity. The method can only be called in the context of the [application](https://helpdesk.bitrix24.com/examples/app.zip) that created it.", "operationId": "crm_activity_configurable_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/crm-activity-configurable-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity, for example `999` ||" }, "fields": { "type": "array", "items": {}, "description": "| Associative array of values for activity fields in the following structure:" }, "layout": { "type": "string", "description": "| Associative array of special structure, describing the appearance of the activity in the timeline ||" } }, "required": [ "id", "fields", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity, for example `999` ||" }, "fields": { "type": "array", "items": {}, "description": "| Associative array of values for activity fields in the following structure:" }, "layout": { "type": "string", "description": "| Associative array of special structure, describing the appearance of the activity in the timeline ||" } }, "required": [ "id", "fields", "layout" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.delete": { "post": { "summary": "Delete activity crm.activity.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.delete` removes an activity of any type.", "operationId": "crm_activity_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity in the timeline, for example `999` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity in the timeline, for example `999` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.fields": { "post": { "summary": "Get a list of fields for crm.activity.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.fields` returns the description of the fields of the system activity.", "operationId": "crm_activity_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.get": { "post": { "summary": "Get information about the activity by ID crm.activity.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.get` returns information about the activity by its ID.", "operationId": "crm_activity_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The ID of the activity in the timeline, for example `999` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The ID of the activity in the timeline, for example `999` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.delete": { "post": { "summary": "Delete a set of additional content blocks in the CRM activity crm.activity.layout.blocks.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.layout.blocks.delete` removes a set of additional content blocks for a activity. Within the application, only the set of additional content blocks that was installed through this application can be deleted.", "operationId": "crm_activity_layout_blocks_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.get": { "post": { "summary": "Get a Set of Additional Content Blocks in the activity crm.activity.layout.blocks.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.layout.blocks.get` retrieves a set of additional content blocks for a activity. Within the application, you can only obtain the set of additional content blocks that has been installed through this application.", "operationId": "crm_activity_layout_blocks_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" } }, "required": [ "entityTypeId", "entityId", "activityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.layout.blocks.set": { "post": { "summary": "Set a set of additional content blocks in the activity crm.activity.layout.blocks.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.layout.blocks.set` sets a set of additional content blocks for the activity. Setting a new set of additional content blocks in the activity will overwrite the previously added set within the same application. Setting a set of additional content blocks cannot be applied to:", "operationId": "crm_activity_layout_blocks_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/layout-blocks/crm-activity-layout-blocks-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" }, "layout": { "type": "string", "description": "| Object describing the set of additional content blocks ||" } }, "required": [ "entityTypeId", "entityId", "activityId", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the activity is linked ||" }, "activityId": { "type": "integer", "description": "| Identifier of the activity ||" }, "layout": { "type": "string", "description": "| Object describing the set of additional content blocks ||" } }, "required": [ "entityTypeId", "entityId", "activityId", "layout" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.list": { "post": { "summary": "Get the list of activities crm.activity.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.list` returns a list of activities based on the filter, considering the access permissions of the current user.", "operationId": "crm_activity_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields of the activity crm.activity.fields that need to be selected. To get the fields `COMMUNICATIONS` and `FILES`, specify them in select." }, "filter": { "type": "object", "description": "| An object for filtering the selected items in key-value format." }, "order": { "type": "object", "description": "| A set of key-value pairs for sorting the output results. The keys can use the fields of the activity crm.activity.fields." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields of the activity crm.activity.fields that need to be selected. To get the fields `COMMUNICATIONS` and `FILES`, specify them in select." }, "filter": { "type": "object", "description": "| An object for filtering the selected items in key-value format." }, "order": { "type": "object", "description": "| A set of key-value pairs for sorting the output results. The keys can use the fields of the activity crm.activity.fields." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.add": { "post": { "summary": "Add Universal Activity crm.activity.todo.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.add` adds a universal activity to the timeline.", "operationId": "crm_activity_todo_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example, `1` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline for the activity, for example `2025-02-03T15:00:00` ||" }, "title": { "type": "string", "description": "| Title of the activity, default is an empty string ||" }, "description": { "type": "string", "description": "| Description of the activity, default is an empty string ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user responsible for the activity, for example `1` ||" }, "parentActivityId": { "type": "integer", "description": "| Identifier of the activity in the timeline with which the created activity can be linked, for example `888` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| An array containing integer values in minutes that allow you to set reminder times for the activity. For example, `[0, 15]` means that 2 reminders will be created, one 15 minutes before the deadline and one at the moment the deadline occurs. Default is an empty array, with no reminders ||" }, "colorId": { "type": "string", "description": "| Identifier of the activity color in the timeline, for example `1`. There are 8 colors available, values from 1 to 7 and a default color if none is specified:" } }, "required": [ "ownerTypeId", "ownerId", "deadline" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example, `1` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline for the activity, for example `2025-02-03T15:00:00` ||" }, "title": { "type": "string", "description": "| Title of the activity, default is an empty string ||" }, "description": { "type": "string", "description": "| Description of the activity, default is an empty string ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user responsible for the activity, for example `1` ||" }, "parentActivityId": { "type": "integer", "description": "| Identifier of the activity in the timeline with which the created activity can be linked, for example `888` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| An array containing integer values in minutes that allow you to set reminder times for the activity. For example, `[0, 15]` means that 2 reminders will be created, one 15 minutes before the deadline and one at the moment the deadline occurs. Default is an empty array, with no reminders ||" }, "colorId": { "type": "string", "description": "| Identifier of the activity color in the timeline, for example `1`. There are 8 colors available, values from 1 to 7 and a default color if none is specified:" } }, "required": [ "ownerTypeId", "ownerId", "deadline" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.update": { "post": { "summary": "Update universal deal crm.activity.todo.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.update` updates a universal deal.", "operationId": "crm_activity_todo_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the deal being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the deal is linked, for example `1` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline of the deal, for example `2025-02-03T15:00:00` ||" }, "title": { "type": "string", "description": "| Title of the deal ||" }, "description": { "type": "string", "description": "| Description of the deal ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user responsible for the deal, for example `1` ||" }, "parentActivityId": { "type": "integer", "description": "| Identifier of the deal in the timeline that can be linked to the updated deal, for example `888` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| An array containing integer values in minutes that allow you to set reminder times for the deal. For example, `[0, 15]` means that 2 reminders will be created, which will come 15 minutes before the deadline and at the moment when the deadline occurs. By default, an empty array, with no reminder..." }, "colorId": { "type": "string", "description": "| Identifier of the deal's color in the timeline, for example `1`. There are 8 colors available, values from 1 to 7 and a default color if none is specified:" } }, "required": [ "id", "ownerTypeId", "ownerId", "deadline" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the deal being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the deal is linked, for example `1` ||" }, "deadline": { "type": "string", "format": "date-time", "description": "| Deadline of the deal, for example `2025-02-03T15:00:00` ||" }, "title": { "type": "string", "description": "| Title of the deal ||" }, "description": { "type": "string", "description": "| Description of the deal ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user responsible for the deal, for example `1` ||" }, "parentActivityId": { "type": "integer", "description": "| Identifier of the deal in the timeline that can be linked to the updated deal, for example `888` ||" }, "pingOffsets": { "type": "array", "items": {}, "description": "| An array containing integer values in minutes that allow you to set reminder times for the deal. For example, `[0, 15]` means that 2 reminders will be created, which will come 15 minutes before the deadline and at the moment when the deadline occurs. By default, an empty array, with no reminder..." }, "colorId": { "type": "string", "description": "| Identifier of the deal's color in the timeline, for example `1`. There are 8 colors available, values from 1 to 7 and a default color if none is specified:" } }, "required": [ "id", "ownerTypeId", "ownerId", "deadline" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateColor": { "post": { "summary": "Update the color of the universal deal crm.activity.todo.updateColor", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.updateColor` updates the color of the universal deal.", "operationId": "crm_activity_todo_updateColor", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-color.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the deal being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the deal is linked, for example, `1` ||" }, "colorId": { "type": "string", "description": "| Identifier of the deal's color in the timeline, for example `1`. There are 8 available colors, values from 1 to 7 and the default color if none is specified:" } }, "required": [ "id", "ownerTypeId", "ownerId", "colorId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the deal being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the deal is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the deal is linked, for example, `1` ||" }, "colorId": { "type": "string", "description": "| Identifier of the deal's color in the timeline, for example `1`. There are 8 available colors, values from 1 to 7 and the default color if none is specified:" } }, "required": [ "id", "ownerTypeId", "ownerId", "colorId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateDeadline": { "post": { "summary": "Update Deadline for Universal Activity crm.activity.todo.updateDeadline", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.updateDeadline` changes the deadline of a universal activity.", "operationId": "crm_activity_todo_updateDeadline", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-deadline.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example, `1` ||" }, "value": { "type": "string", "format": "date-time", "description": "| New deadline for the activity ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example, `1` ||" }, "value": { "type": "string", "format": "date-time", "description": "| New deadline for the activity ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateDescription": { "post": { "summary": "Update the description of the universal activity crm.activity.todo.updateDescription", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.updateDescription` changes the description in the universal activity.", "operationId": "crm_activity_todo_updateDescription", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-description.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example `1` ||" }, "value": { "type": "string", "description": "| New description of the activity ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example `1` ||" }, "value": { "type": "string", "description": "| New description of the activity ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.todo.updateResponsibleUser": { "post": { "summary": "Update the responsible user for the universal activity crm.activity.todo.updateResponsibleUser", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.todo.updateResponsibleUser` updates the responsible user for the universal activity.", "operationId": "crm_activity_todo_updateResponsibleUser", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/todo/crm-activity-todo-update-responsible-user.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example `1` ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user who will become responsible for the activity, for example `1` ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the activity being updated, for example `999` ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the activity is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the activity is linked, for example `1` ||" }, "responsibleId": { "type": "integer", "description": "| Identifier of the user who will become responsible for the activity, for example `1` ||" } }, "required": [ "id", "ownerTypeId", "ownerId", "responsibleId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.add": { "post": { "summary": "Add Custom Activity Type crm.activity.type.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.type.add` registers a custom activity type by specifying a name and an icon.", "operationId": "crm_activity_type_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/types/crm-activity-type-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding a new custom activity type in the form of a structure:" }, "TYPE_ID": { "type": "string", "description": "| String value of the activity type, for example `QuickBooks and other similar platforms`. When creating an activity, this field is `PROVIDER_TYPE_ID` ||" }, "NAME": { "type": "string", "description": "| Name of the activity type, for example `Activity for QuickBooks` for a deal. Default is an empty string ||" }, "ICON_FILE": { "type": "string", "description": "| Icon file for the activity type, described according to rules ||" }, "IS_CONFIGURABLE_TYPE": { "type": "string", "description": "| Default value is `N`. Value `Y` indicates that the type will be used for configurable activities ||" } }, "required": [ "fields", "TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for adding a new custom activity type in the form of a structure:" }, "TYPE_ID": { "type": "string", "description": "| String value of the activity type, for example `QuickBooks and other similar platforms`. When creating an activity, this field is `PROVIDER_TYPE_ID` ||" }, "NAME": { "type": "string", "description": "| Name of the activity type, for example `Activity for QuickBooks` for a deal. Default is an empty string ||" }, "ICON_FILE": { "type": "string", "description": "| Icon file for the activity type, described according to rules ||" }, "IS_CONFIGURABLE_TYPE": { "type": "string", "description": "| Default value is `N`. Value `Y` indicates that the type will be used for configurable activities ||" } }, "required": [ "fields", "TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.delete": { "post": { "summary": "Delete Custom Activity Type crm.activity.type.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.type.delete` removes a custom activity type.", "operationId": "crm_activity_type_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/types/crm-activity-type-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TYPE_ID": { "type": "string", "description": "| String value of the activity type, for example `QuickBooks and other similar platforms` ||" } }, "required": [ "TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TYPE_ID": { "type": "string", "description": "| String value of the activity type, for example `QuickBooks and other similar platforms` ||" } }, "required": [ "TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.type.list": { "post": { "summary": "Get a list of custom activity types crm.activity.type.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.type.list` retrieves a list of custom activity types registered by the application.", "operationId": "crm_activity_type_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/types/crm-activity-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.activity.update": { "post": { "summary": "Update System CRM Activity crm.activity.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.update](../todo/crm-activity-todo-update.md). The method `crm.activity.update` updates an existing activity.", "operationId": "crm_activity_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity in the timeline, for example `999` ||" }, "fields": { "type": "array", "items": {}, "description": "| Array of values for activity fields in the following structure:" }, "Field": { "type": "string", "description": "`type` | Description ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the CRM entity ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Identifier of the CRM object type ||" }, "TYPE_ID": { "type": "string", "description": "| Type of the activity ||" }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Identifier of the entity associated with the activity ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Description of the communication ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Date and time of the activity deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings, and from END_TIME for tasks ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the activity ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Type of description ||" }, "DIRECTION": { "type": "string", "description": "| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| End time of the activity | ||" }, "FILES": { "type": "string", "description": "| Files added to the activity ||" }, "LOCATION": { "type": "string", "description": "| Location ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Type of notification ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source, used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the entity in the data source, used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, it can be edited in CRM without fear that the next export will overwrite the data ||" }, "PRIORITY": { "type": "string", "description": "| Priority ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Additional provider data ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Identifier of the provider group ||" }, "PROVIDER_ID": { "type": "string", "description": "| Identifier of the provider ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Identifier of the provider type, status from the directory ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Additional provider parameters ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Identifier of the user responsible for the activity ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Start time of the activity ||" }, "STATUS": { "type": "string", "description": "| Status of the activity ||" }, "SUBJECT": { "type": "string", "description": "| Additional description of the activity ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Added files. Deprecated, retained for compatibility ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||" } }, "required": [ "id", "fields", "OWNER_ID", "OWNER_TYPE_ID", "TYPE_ID", "COMMUNICATIONS", "RESPONSIBLE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the activity in the timeline, for example `999` ||" }, "fields": { "type": "array", "items": {}, "description": "| Array of values for activity fields in the following structure:" }, "Field": { "type": "string", "description": "`type` | Description ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the CRM entity ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Identifier of the CRM object type ||" }, "TYPE_ID": { "type": "string", "description": "| Type of the activity ||" }, "ASSOCIATED_ENTITY_ID": { "type": "integer", "description": "| Identifier of the entity associated with the activity ||" }, "COMMUNICATIONS": { "type": "string", "description": "| Description of the communication ||" }, "DEADLINE": { "type": "string", "format": "date-time", "description": "| Date and time of the activity deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings, and from END_TIME for tasks ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the activity ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Type of description ||" }, "DIRECTION": { "type": "string", "description": "| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||" }, "END_TIME": { "type": "string", "format": "date-time", "description": "| End time of the activity | ||" }, "FILES": { "type": "string", "description": "| Files added to the activity ||" }, "LOCATION": { "type": "string", "description": "| Location ||" }, "NOTIFY_TYPE": { "type": "string", "description": "| Type of notification ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source, used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the entity in the data source, used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, it can be edited in CRM without fear that the next export will overwrite the data ||" }, "PRIORITY": { "type": "string", "description": "| Priority ||" }, "PROVIDER_DATA": { "type": "string", "description": "| Additional provider data ||" }, "PROVIDER_GROUP_ID": { "type": "string", "description": "| Identifier of the provider group ||" }, "PROVIDER_ID": { "type": "string", "description": "| Identifier of the provider ||" }, "PROVIDER_TYPE_ID": { "type": "string", "description": "| Identifier of the provider type, status from the directory ||" }, "PROVIDER_PARAMS": { "type": "object", "description": "| Additional provider parameters ||" }, "RESPONSIBLE_ID": { "type": "string", "description": "| Identifier of the user responsible for the activity ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings ||" }, "START_TIME": { "type": "string", "format": "date-time", "description": "| Start time of the activity ||" }, "STATUS": { "type": "string", "description": "| Status of the activity ||" }, "SUBJECT": { "type": "string", "description": "| Additional description of the activity ||" }, "WEBDAV_ELEMENTS": { "type": "string", "description": "| Added files. Deprecated, retained for compatibility ||" }, "IS_INCOMING_CHANNEL": { "type": "string", "maxLength": 1, "description": "| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||" } }, "required": [ "id", "fields", "OWNER_ID", "OWNER_TYPE_ID", "TYPE_ID", "COMMUNICATIONS", "RESPONSIBLE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.add": { "post": { "summary": "Add Address crm.address.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new address for a requisite or lead. For the user, this address appears as the address of a contact, company, or lead. Multiple addresses of different [types](../../auxiliary/enum/crm-enum-address-type.md) can be created, linked to a single requisite.", "operationId": "crm_address_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/addresses/crm-address-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the address ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object (requisite or lead) ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| District ||" }, "PROVINCE": { "type": "string", "description": "| State ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the address ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object (requisite or lead) ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| District ||" }, "PROVINCE": { "type": "string", "description": "| State ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.delete": { "post": { "summary": "Delete address crm.address.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method deletes an address.", "operationId": "crm_address_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/addresses/crm-address-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for deleting the address ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object (detail or lead) ||" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for deleting the address ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object (detail or lead) ||" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.fields": { "post": { "summary": "Get Description of Address Fields crm.address.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a formal description of the address fields. No parameters.", "operationId": "crm_address_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/addresses/crm-address-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| Region ||" }, "PROVINCE": { "type": "string", "description": "| Province ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Identifier of the main parent object type." }, "ANCHOR_ID": { "type": "integer", "description": "| This field is for internal use. The value is automatically filled when adding an address." }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| \"Required\" attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| \"Read-only\" attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| \"Immutable\" attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| \"Multiple\" attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| \"Custom\" attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| Region ||" }, "PROVINCE": { "type": "string", "description": "| Province ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Identifier of the main parent object type." }, "ANCHOR_ID": { "type": "integer", "description": "| This field is for internal use. The value is automatically filled when adding an address." }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| \"Required\" attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| \"Read-only\" attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| \"Immutable\" attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| \"Multiple\" attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| \"Custom\" attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.list": { "post": { "summary": "Get a List of Addresses by Filter crm.address.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of addresses based on the filter. Addresses are moved to the details. In the CRM card, they are displayed as a separate field. Multiple details can be linked to a CRM object. Within a detail, there can be several addresses (each of a different type).", "operationId": "crm_address_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/addresses/crm-address-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see address fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected addresses in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected addresses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| Region ||" }, "PROVINCE": { "type": "string", "description": "| Province ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Identifier of the main parent object's type." }, "ANCHOR_ID": { "type": "integer", "description": "| This field is for internal use. The value is automatically filled when adding an address." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see address fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected addresses in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected addresses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "TYPE_ID": { "type": "integer", "description": "| Identifier of the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| Region ||" }, "PROVINCE": { "type": "string", "description": "| Province ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "| Identifier of the location address." }, "ANCHOR_TYPE_ID": { "type": "integer", "description": "| Identifier of the main parent object's type." }, "ANCHOR_ID": { "type": "integer", "description": "| This field is for internal use. The value is automatically filled when adding an address." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.address.update": { "post": { "summary": "Update Address for crm.address.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the address for a contact or lead.", "operationId": "crm_address_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/addresses/crm-address-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` to update the address." }, "TYPE_ID": { "type": "integer", "description": "| Identifier for the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier for the parent object type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier for the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| District ||" }, "PROVINCE": { "type": "string", "description": "| State ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "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": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` to update the address." }, "TYPE_ID": { "type": "integer", "description": "| Identifier for the address type. Enumeration element \"Address Type\"." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier for the parent object type." }, "ENTITY_ID": { "type": "string", "description": "| Identifier for the parent object ||" }, "ADDRESS_1": { "type": "string", "description": "| Street, house, building, structure ||" }, "ADDRESS_2": { "type": "string", "description": "| Apartment / office ||" }, "CITY": { "type": "string", "description": "| City ||" }, "POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "REGION": { "type": "string", "description": "| District ||" }, "PROVINCE": { "type": "string", "description": "| State ||" }, "COUNTRY": { "type": "string", "description": "| Country ||" }, "COUNTRY_CODE": { "type": "string", "description": "| Country code." }, "LOC_ADDR_ID": { "type": "integer", "description": "|" } }, "required": [ "fields", "TYPE_ID", "ENTITY_TYPE_ID", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.add": { "post": { "summary": "Create Digital Workspace crm.automatedsolution.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. - there is a link to the data-types file, need to check that the type crm_dynamic_type is described (from SPAs) This method will create a new digital workspace. In the cloud, the maximum number of digital workspaces depends on the plan. In on-premise, the maximum number depends on technical limitations.", "operationId": "crm_automatedsolution_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a digital workspace in the form of a structure:" }, "title": { "type": "string", "description": "| The name of the digital workspace. The link to the corresponding section on the account will be built based on the title of the digital workspace. ||" }, "typeIds": { "type": "string", "description": "| An array of identifiers of SPAs that need to be linked to this workspace." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a digital workspace in the form of a structure:" }, "title": { "type": "string", "description": "| The name of the digital workspace. The link to the corresponding section on the account will be built based on the title of the digital workspace. ||" }, "typeIds": { "type": "string", "description": "| An array of identifiers of SPAs that need to be linked to this workspace." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.delete": { "post": { "summary": "Delete Digital Workplace crm.automatedsolution.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an existing digital workplace with the identifier `id`. Deletion of the digital workplace is only possible if there are no bound SPAs associated with it. If there are SPAs, they must first be unbound or reassigned to another workplace before deleting this digital workplace.", "operationId": "crm_automatedsolution_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace. It can be obtained from the response of the method crm.automatedsolution.add (`result.automatedSolution.id`), which was called when adding the digital workplace, or crm.automatedsolution.list. You can also use the \"Digital Workplaces\" section on the Bitrix24..." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace. It can be obtained from the response of the method crm.automatedsolution.add (`result.automatedSolution.id`), which was called when adding the digital workplace, or crm.automatedsolution.list. You can also use the \"Digital Workplaces\" section on the Bitrix24..." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.fields": { "post": { "summary": "Get fields of the digital workplace crm.automatedsolution.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about the fields of the digital workplace settings. No parameters.", "operationId": "crm_automatedsolution_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` — fields of the digital workplace, and `value` — an object of type `rest_field_description`. ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` — fields of the digital workplace, and `value` — an object of type `rest_field_description`. ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.get": { "post": { "summary": "Get data about the digital workplace by id crm.automatedsolution.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about the digital workplace with the identifier `id`.", "operationId": "crm_automatedsolution_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.list": { "post": { "summary": "Get a list of digital workspaces crm.automatedsolution.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method will return an array of digital workspace settings. Each element of the array is a structure similar to the response from the request [crm.automatedsolution.get](./crm-automated-solution-get.md).", "operationId": "crm_automatedsolution_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| List for sorting in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where the key is the field and the value is `ASC` or `DESC`. Available fields for sorting:" }, "filter": { "type": "object", "description": "| Object for filtering selected digital workspaces in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Available fields for filtering:" }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| List for sorting in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where the key is the field and the value is `ASC` or `DESC`. Available fields for sorting:" }, "filter": { "type": "object", "description": "| Object for filtering selected digital workspaces in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Available fields for filtering:" }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automatedsolution.update": { "post": { "summary": "Update Digital Workplace crm.automatedsolution.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. - there is a link to the data-types file, check that the type crm_dynamic_type is described there (from SPAs) This method updates the existing settings of the digital workplace with the identifier `id`. If any of the fields are not provided, their values will remain unchanged.", "operationId": "crm_automatedsolution_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automated-solution/crm-automated-solution-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace. It can be obtained from the response of the method crm.automatedsolution.add (result.automatedSolution.id), which was called when adding the digital workplace, or crm.automatedsolution.list. You can also use the \"Digital Workplaces\" section in the Bitrix24 a..." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a digital workplace in the following structure:" }, "title": { "type": "string", "description": "| Title of the digital workplace." }, "typeIds": { "type": "string", "description": "| Array of identifiers of SPAs that need to be linked to this workplace." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the digital workplace. It can be obtained from the response of the method crm.automatedsolution.add (result.automatedSolution.id), which was called when adding the digital workplace, or crm.automatedsolution.list. You can also use the \"Digital Workplaces\" section in the Bitrix24 a..." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a digital workplace in the following structure:" }, "title": { "type": "string", "description": "| Title of the digital workplace." }, "typeIds": { "type": "string", "description": "| Array of identifiers of SPAs that need to be linked to this workplace." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger": { "post": { "summary": "Activate the crm.automation.trigger", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Bitrix24 allows users to create a special custom trigger \"Track Incoming Webhook.\" The user is provided with a ready-made URL of the form", "operationId": "crm_automation_trigger", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automation/crm-automation-trigger.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "| Target object for automation, specified in the form of `TYPENAME_ID` (for example, `LEAD_25`)" }, "code": { "type": "string", "description": "| Unique symbolic code of the trigger configured in Automation for a specific status/stage of the document. The `code` parameter can be obtained from the trigger settings ||" } }, "required": [ "target" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "target": { "type": "string", "description": "| Target object for automation, specified in the form of `TYPENAME_ID` (for example, `LEAD_25`)" }, "code": { "type": "string", "description": "| Unique symbolic code of the trigger configured in Automation for a specific status/stage of the document. The `code` parameter can be obtained from the trigger settings ||" } }, "required": [ "target" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.add": { "post": { "summary": "Add Trigger crm.automation.trigger.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a trigger. The method can only be executed in the application context, as the added triggers are tied to this application.", "operationId": "crm_automation_trigger_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automation/triggers/crm-automation-trigger-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]`." }, "NAME": { "type": "string", "description": "| Name of the trigger ||" } }, "required": [ "CODE", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]`." }, "NAME": { "type": "string", "description": "| Name of the trigger ||" } }, "required": [ "CODE", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.execute": { "post": { "summary": "Execute the Trigger crm.automation.trigger.execute", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method initiates the execution of a trigger. The method can only be called in the application context.", "operationId": "crm_automation_trigger_execute", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automation/triggers/crm-automation-trigger-execute.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]` ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Type of the CRM object according to the crm.enum.ownertype reference (For example, `1` — lead)" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the entity ||" } }, "required": [ "CODE", "OWNER_TYPE_ID", "OWNER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]` ||" }, "OWNER_TYPE_ID": { "type": "integer", "description": "| Type of the CRM object according to the crm.enum.ownertype reference (For example, `1` — lead)" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the entity ||" } }, "required": [ "CODE", "OWNER_TYPE_ID", "OWNER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.automation.trigger.list": { "post": { "summary": "Get the list of triggers crm.automation.trigger.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of applications and triggers. The method can only be executed in the application context. No parameters.", "operationId": "crm_automation_trigger_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automation/triggers/crm-automation-trigger-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Returns an array of triggers added by the application with fields `NAME` and `CODE` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Returns an array of triggers added by the application with fields `NAME` and `CODE` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.add": { "post": { "summary": "Create a New Call List crm.calllist.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.calllist.add` creates a new call list.", "operationId": "crm_calllist_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Type of the object:" }, "ENTITIES": { "type": "array", "items": {}, "description": "| Array of `ID` of contacts or companies, which can be obtained using the crm.item.list method ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` of the CRM form that will be displayed in the call list form." } }, "required": [ "ENTITY_TYPE", "ENTITIES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Type of the object:" }, "ENTITIES": { "type": "array", "items": {}, "description": "| Array of `ID` of contacts or companies, which can be obtained using the crm.item.list method ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` of the CRM form that will be displayed in the call list form." } }, "required": [ "ENTITY_TYPE", "ENTITIES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.get": { "post": { "summary": "Get Information About the Call List crm.calllist.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.calllist.get` returns information about the call list by its identifier, without the list of participants.", "operationId": "crm_calllist_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the call list ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the call list ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.items.get": { "post": { "summary": "Get the list of call participants crm.calllist.items.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.calllist.items.get` returns a list of participants, contacts, or companies, along with the call status.", "operationId": "crm_calllist_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-items-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Identifier of the call list, which can be obtained using the methods crm.calllist.add and crm.calllist.list ||" }, "FILTER": { "type": "object", "description": "| Filter by the call status of the item: `{ STATUS: \"status_code\" }`." } }, "required": [ "LIST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Identifier of the call list, which can be obtained using the methods crm.calllist.add and crm.calllist.list ||" }, "FILTER": { "type": "object", "description": "| Filter by the call status of the item: `{ STATUS: \"status_code\" }`." } }, "required": [ "LIST_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.list": { "post": { "summary": "Get the list of call lists crm.calllist.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.calllist.list` returns a list of call list activities.", "operationId": "crm_calllist_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Array of fields to retrieve. By default, all fields are returned." }, "FILTER": { "type": "object", "description": "| Object format:" }, "ORDER": { "type": "object", "description": "| Object format:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| Array of fields to retrieve. By default, all fields are returned." }, "FILTER": { "type": "object", "description": "| Object format:" }, "ORDER": { "type": "object", "description": "| Object format:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.statuslist": { "post": { "summary": "Get the list of call statuses crm.calllist.statuslist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.calllist.statuslist` returns a list of call statuses. To create a new status, modify, or delete an existing one, use the methods [crm.status.*](../status/index.md).", "operationId": "crm_calllist_statuslist", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-statuslist.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.calllist.update": { "post": { "summary": "Update Call List Composition crm.calllist.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `crm.calllist.update` method allows you to add or remove participants from an existing call list and update the associated CRM form.", "operationId": "crm_calllist_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/call-list/crm-calllist-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Identifier of the call list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of entity:" }, "ENTITIES": { "type": "array", "items": {}, "description": "| Array of `ID`s of contacts or companies, which can be obtained using the crm.item.list method ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` of the CRM form that will be displayed in the call form." } }, "required": [ "LIST_ID", "ENTITY_TYPE", "ENTITIES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LIST_ID": { "type": "integer", "description": "| Identifier of the call list ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of entity:" }, "ENTITIES": { "type": "array", "items": {}, "description": "| Array of `ID`s of contacts or companies, which can be obtained using the crm.item.list method ||" }, "WEBFORM_ID": { "type": "integer", "description": "| `ID` of the CRM form that will be displayed in the call form." } }, "required": [ "LIST_ID", "ENTITY_TYPE", "ENTITIES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.fields": { "post": { "summary": "Get Product Catalog Fields crm.catalog.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.catalog.getFields](../../../catalog/catalog/catalog-catalog-get-fields.md). This method returns the description of the product catalog fields. No parameters required.", "operationId": "crm_catalog_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/catalog/crm-catalog-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier. Read-only ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Data source identifier. Used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source. Used only for linking to an external source ||" }, "XML_ID": { "type": "string", "description": "| Symbolic code. Read-only ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier. Read-only ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Data source identifier. Used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source. Used only for linking to an external source ||" }, "XML_ID": { "type": "string", "description": "| Symbolic code. Read-only ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.get": { "post": { "summary": "Get Product Catalog by ID crm.catalog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.catalog.get](../../../catalog/catalog/catalog-catalog-get.md). This method returns the product catalog by ID.", "operationId": "crm_catalog_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/catalog/crm-catalog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product catalog ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product catalog ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.catalog.list": { "post": { "summary": "Get a List of Product Catalogs crm.catalog.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.catalog.list](../../../catalog/catalog/catalog-catalog-list.md). This method returns a list of product catalogs. It is an implementation of the listing method for product catalogs. See the description of [listing methods](../../../../settings/how-to-call-rest-api/list-methods-pecularities.md).", "operationId": "crm_catalog_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/catalog/crm-catalog-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.add": { "post": { "summary": "Add a New Sales Funnel crm.category.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new sales funnel (direction) for the CRM object type with the identifier `entityTypeId`.", "operationId": "crm_category_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM entity for which the new funnel will be created ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new funnel in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the funnel. The name can be:" }, "sort": { "type": "integer", "description": "| Sort index." }, "isDefault": { "type": "boolean", "description": "| Indicates whether the funnel is the default funnel. Can have values:" } }, "required": [ "entityTypeId", "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM entity for which the new funnel will be created ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new funnel in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the funnel. The name can be:" }, "sort": { "type": "integer", "description": "| Sort index." }, "isDefault": { "type": "boolean", "description": "| Indicates whether the funnel is the default funnel. Can have values:" } }, "required": [ "entityTypeId", "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.delete": { "post": { "summary": "Delete Sales Funnel crm.category.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a funnel (direction) with the identifier `id`. * Default funnels * Funnels that have at least one element", "operationId": "crm_category_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM entity from which the funnel will be deleted ||" }, "id": { "type": "integer", "description": "| Identifier of the funnel to be deleted. Can be obtained using the `crm.category.list` method or when creating a funnel with the `crm.category.add` method ||" } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM entity from which the funnel will be deleted ||" }, "id": { "type": "integer", "description": "| Identifier of the funnel to be deleted. Can be obtained using the `crm.category.list` method or when creating a funnel with the `crm.category.add` method ||" } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.fields": { "post": { "summary": "Get Fields of the Sales Funnel crm.category.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves information about the fields of the sales funnels (directions) of the CRM object.", "operationId": "crm_category_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM objects for which to retrieve information about the funnel fields ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM objects for which to retrieve information about the funnel fields ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.get": { "post": { "summary": "Get the funnel by Id crm.category.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about the funnel (direction) with the identifier `id`.", "operationId": "crm_category_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM object for which we want to get the funnel ||" }, "id": { "type": "integer", "description": "| Funnel identifier. Can be obtained using the `crm.category.list` method or when creating a funnel using the `crm.category.add` method ||" } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of the CRM object for which we want to get the funnel ||" }, "id": { "type": "integer", "description": "| Funnel identifier. Can be obtained using the `crm.category.list` method or when creating a funnel using the `crm.category.add` method ||" } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.list": { "post": { "summary": "Get the list of Sales Funnels crm.category.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of sales funnels (directions) that belong to the CRM object type with the identifier `entityTypeId`. The list of returned funnels is filtered by access permissions. This means that if a user does not have permission to read a specific funnel, it will not be included in the response.", "operationId": "crm_category_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM entities for which to retrieve the list of funnels ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM entities for which to retrieve the list of funnels ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.category.update": { "post": { "summary": "Update Sales Funnel crm.category.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the funnel (direction) with the identifier `id`, setting new values for the fields from `fields`. If any field is missing in `fields`, its value will remain unchanged.", "operationId": "crm_category_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/category/crm-category-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM entities for which the funnel will be updated ||" }, "id": { "type": "integer", "description": "| Identifier of the funnel. It can be obtained using the `crm.category.list` method or when creating a funnel with the `crm.category.add` method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the funnel fields in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the funnel. The name can be:" }, "sort": { "type": "integer", "description": "| Sort index." }, "isDefault": { "type": "boolean", "description": "| Indicates whether the funnel is the default funnel. Can have values:" } }, "required": [ "entityTypeId", "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM entities for which the funnel will be updated ||" }, "id": { "type": "integer", "description": "| Identifier of the funnel. It can be obtained using the `crm.category.list` method or when creating a funnel with the `crm.category.add` method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the funnel fields in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the funnel. The name can be:" }, "sort": { "type": "integer", "description": "| Sort index." }, "isDefault": { "type": "boolean", "description": "| Indicates whether the funnel is the default funnel. Can have values:" } }, "required": [ "entityTypeId", "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.add": { "post": { "summary": "Create a New Company crm.company.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.company.add` creates a new company.", "operationId": "crm_company_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters:" }, "TITLE": { "type": "string", "description": "| Company name ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Company type." }, "INDUSTRY": { "type": "string", "description": "| Industry." }, "EMPLOYEES": { "type": "string", "description": "| Number of employees." }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "REVENUE": { "type": "number", "format": "double", "description": "| Annual revenue ||" }, "LOGO": { "type": "string", "description": "| Company logo ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the company available to everyone? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the element." }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system, e.g., Google Ads ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search term. For example, keywords for contextual advertising ||" }, "IS_MY_COMPANY": { "type": "string", "maxLength": 1, "description": "| Is the company \"my company\"? Possible values:" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this company ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the company in the external system ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Version of the data in the external system. Used to protect data from accidental overwriting ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Created by ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters:" }, "TITLE": { "type": "string", "description": "| Company name ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Company type." }, "INDUSTRY": { "type": "string", "description": "| Industry." }, "EMPLOYEES": { "type": "string", "description": "| Number of employees." }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "REVENUE": { "type": "number", "format": "double", "description": "| Annual revenue ||" }, "LOGO": { "type": "string", "description": "| Company logo ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the company available to everyone? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the element." }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system, e.g., Google Ads ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search term. For example, keywords for contextual advertising ||" }, "IS_MY_COMPANY": { "type": "string", "maxLength": 1, "description": "| Is the company \"my company\"? Possible values:" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this company ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the company in the external system ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Version of the data in the external system. Used to protect data from accidental overwriting ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Created by ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.add": { "post": { "summary": "Add Contact to the Specified Company crm.company.contact.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.add` adds a contact to the specified company.", "operationId": "crm_company_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "fields": { "type": "object", "description": "| Object in the following format:" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact to be linked to the company." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Indicates whether the link is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "fields": { "type": "object", "description": "| Object in the following format:" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact to be linked to the company." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Indicates whether the link is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.delete": { "post": { "summary": "Delete Contact from Specified Company crm.company.contact.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.delete` removes a contact from the specified company.", "operationId": "crm_company_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "fields": { "type": "object", "description": "| An object containing information about which contact needs to be removed from the bindings." }, "fields.CONTACT_ID": { "type": "string", "description": "| Identifier of the contact to be removed from the bindings ||" } }, "required": [ "id", "fields", "fields.CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "fields": { "type": "object", "description": "| An object containing information about which contact needs to be removed from the bindings." }, "fields.CONTACT_ID": { "type": "string", "description": "| Identifier of the contact to be removed from the bindings ||" } }, "required": [ "id", "fields", "fields.CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.fields": { "post": { "summary": "Get Fields for Company-Contact Connection crm.company.contact.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.fields` returns the description of fields for the company-contact connection.", "operationId": "crm_company_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.delete": { "post": { "summary": "Clear the set of contacts associated with the specified company crm.company.contact.items.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.items.delete` clears the set of contacts associated with the specified company.", "operationId": "crm_company_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.get": { "post": { "summary": "Retrieve a Set of Contacts Associated with a Specified Company crm.company.contact.items.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.items.get` returns a set of contacts associated with the specified company.", "operationId": "crm_company_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.contact.items.set": { "post": { "summary": "Set a Set of Contacts Associated with the Specified Company crm.company.contact.items.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.contact.items.set` sets a set of contacts associated with the specified company.", "operationId": "crm_company_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/contacts/crm-company-contact-items-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "items": { "type": "string", "description": "| A set of objects that describe the associated contacts for the company. The structure of an individual binding object is detailed below ||" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact that will be associated with the company." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Indicates whether the binding is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "items", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the company." }, "items": { "type": "string", "description": "| A set of objects that describe the associated contacts for the company. The structure of an individual binding object is detailed below ||" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact that will be associated with the company." }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| Indicates whether the binding is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "items", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.delete": { "post": { "summary": "Delete Company crm.company.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.company.delete` removes a company.", "operationId": "crm_company_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Set Common Company Card for All Users crm.company.details.configuration.forceCommonScopeForAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.company.details.configuration.forceCommonScopeForAll` enforces a common company card for all users.", "operationId": "crm_company_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-force-common-scope-for-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.get": { "post": { "summary": "Get Parameters for crm.company.details.configuration.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.company.details.configuration.get` retrieves the settings for company cards: it reads the personal settings of the specified user or the shared settings defined for all users.", "operationId": "crm_company_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier, which can be obtained using the user.get method." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier, which can be obtained using the user.get method." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.reset": { "post": { "summary": "Reset Company Card Settings: crm.company.details.configuration.reset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.company.details.configuration.reset` resets the settings of company cards: it removes the personal settings of the specified user or the general settings defined for all users.", "operationId": "crm_company_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-reset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| The user identifier, which can be obtained using the user.get method. Required only when resetting personal settings." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| The user identifier, which can be obtained using the user.get method. Required only when resetting personal settings." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.details.configuration.set": { "post": { "summary": "Set Parameters for crm.company.details.configuration.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.company.details.configuration.set` sets the settings for company cards: it records the personal settings of the specified user or the common settings for all users.", "operationId": "crm_company_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/custom-form/crm-company-details-configuration-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| The user identifier, which can be obtained using the user.get method. Required only when setting personal settings." }, "data": { "type": "string", "description": "| The list of `section` describes the configuration of field sections in the company card." }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section." }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| The array `section_element` describes the configuration of fields in the section." }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional list of options for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier for the default address type. To find out possible address types, use `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" } }, "required": [ "data", "name", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| The user identifier, which can be obtained using the user.get method. Required only when setting personal settings." }, "data": { "type": "string", "description": "| The list of `section` describes the configuration of field sections in the company card." }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section." }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| The array `section_element` describes the configuration of fields in the section." }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional list of options for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier for the default address type. To find out possible address types, use `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" } }, "required": [ "data", "name", "title", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.fields": { "post": { "summary": "Get Company Fields Description crm.company.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.company.fields` returns the description of company fields, including [custom fields](./userfields/index.md).", "operationId": "crm_company_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.get": { "post": { "summary": "Get Company Information crm.company.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.company.get` returns a company by its identifier.", "operationId": "crm_company_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.list": { "post": { "summary": "Get a List of Companies by Filter crm.company.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.company.list` returns a list of companies based on a filter. It is an implementation of the [list method](../../../settings/how-to-call-rest-api/list-methods-pecularities.md) for companies.", "operationId": "crm_company_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields to limit the selection." }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Parameter for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| List of fields to limit the selection." }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Parameter for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.update": { "post": { "summary": "Update Existing Company crm.company.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.company.update` updates an existing company.", "operationId": "crm_company_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/crm-company-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" }, "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object containing a set of additional parameters:" }, "TITLE": { "type": "string", "description": "| Company name ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Company type. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=COMPANY_TYPE` ||" }, "LOGO": { "type": "string", "description": "| Logo ||" }, "INDUSTRY": { "type": "string", "description": "| Industry. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=INDUSTRY` ||" }, "EMPLOYEES": { "type": "string", "description": "| Number of employees. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=EMPLOYEES` ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency ||" }, "REVENUE": { "type": "number", "format": "double", "description": "| Annual revenue ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the company available to everyone? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "CONTACT_ID": { "type": "string", "description": "| Contact. Multiple ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source. Used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source. Used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version. Used to protect data from accidental overwriting by an external system ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system. Google Ads, Microsoft Advertising, and others ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "PHONE": { "type": "string", "description": "| Phone. Multiple ||" }, "EMAIL": { "type": "string", "description": "| E-mail. Multiple ||" }, "WEB": { "type": "string", "description": "| Website. Multiple ||" }, "IM": { "type": "string", "description": "| Messenger. Multiple ||" }, "LINK": { "type": "string", "description": "| LINK. Multiple ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Company identifier ||" }, "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object containing a set of additional parameters:" }, "TITLE": { "type": "string", "description": "| Company name ||" }, "COMPANY_TYPE": { "type": "string", "description": "| Company type. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=COMPANY_TYPE` ||" }, "LOGO": { "type": "string", "description": "| Logo ||" }, "INDUSTRY": { "type": "string", "description": "| Industry. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=INDUSTRY` ||" }, "EMPLOYEES": { "type": "string", "description": "| Number of employees. Values can be obtained using the method crm.status.list with a filter for `ENTITY_ID=EMPLOYEES` ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency ||" }, "REVENUE": { "type": "number", "format": "double", "description": "| Annual revenue ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the company available to everyone? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "CONTACT_ID": { "type": "string", "description": "| Contact. Multiple ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source. Used only for linking to an external source ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source. Used only for linking to an external source ||" }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version. Used to protect data from accidental overwriting by an external system ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system. Google Ads, Microsoft Advertising, and others ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "PHONE": { "type": "string", "description": "| Phone. Multiple ||" }, "EMAIL": { "type": "string", "description": "| E-mail. Multiple ||" }, "WEB": { "type": "string", "description": "| Website. Multiple ||" }, "IM": { "type": "string", "description": "| Messenger. Multiple ||" }, "LINK": { "type": "string", "description": "| LINK. Multiple ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.add": { "post": { "summary": "Create a Custom Field for Companies crm.company.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.userfield.add` creates a new custom field for companies.", "operationId": "crm_company_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` field type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list item." }, "DEF": { "type": "boolean", "description": "| Is the list item the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` field type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list item." }, "DEF": { "type": "boolean", "description": "| Is the list item the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.delete": { "post": { "summary": "Delete Custom Field for Companies crm.company.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.userfield.delete` removes a custom field for companies.", "operationId": "crm_company_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the company." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the company." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.get": { "post": { "summary": "Get Company Custom Field by ID crm.company.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.userfield.get` returns a company custom field by its ID.", "operationId": "crm_company_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the company." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the company." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.list": { "post": { "summary": "Get a list of custom fields for companies crm.company.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.userfield.list` returns a list of custom fields for companies based on the filter.", "operationId": "crm_company_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values participate in search. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values participate in search. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.company.userfield.update": { "post": { "summary": "Update Company User Field crm.company.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.company.userfield.update` updates an existing company user field.", "operationId": "crm_company_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/companies/userfields/crm-company-userfield-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type `USER_TYPE_ID` has its own pool of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the user field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the user field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type `USER_TYPE_ID` has its own pool of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the user field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the user field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.add": { "post": { "summary": "Create a New Contact crm.contact.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.contact.add` creates a new contact.", "operationId": "crm_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters." }, "HONORIFIC": { "type": "string", "description": "| Salutation." }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "PHOTO": { "type": "string", "description": "| Photograph ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Date of birth ||" }, "TYPE_ID": { "type": "string", "description": "| Contact type." }, "SOURCE_ID": { "type": "string", "description": "| Source." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "POST": { "type": "string", "description": "| Position ||" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "OPENED": { "type": "boolean", "description": "| Is it available to everyone? Possible values:" }, "EXPORT": { "type": "boolean", "description": "| Is the contact included in the export? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the item." }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the main company for the contact." }, "COMPANY_IDS": { "type": "string", "description": "| Array of identifiers of companies associated with the contact." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google Ads, Microsoft Advertising, etc.) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search condition. For example, keywords for contextual advertising ||" }, "TRACE": { "type": "string", "description": "| Information for Sales Intelligence ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "LINK": { "type": "string", "description": "| Links. Service field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this contact ||" }, "ORIGIN_ID": { "type": "string", "description": "| Version of the contact data in the external system. Used to protect data from accidental overwriting by the external system." }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date." }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date." }, "CREATED_BY_ID": { "type": "string", "description": "| Created by." }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by." }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Location address identifier ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of adding a contact be registered in the live feed? Possible values:" }, "IMPORT": { "type": "boolean", "description": "| Is import mode enabled? Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters." }, "HONORIFIC": { "type": "string", "description": "| Salutation." }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "PHOTO": { "type": "string", "description": "| Photograph ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Date of birth ||" }, "TYPE_ID": { "type": "string", "description": "| Contact type." }, "SOURCE_ID": { "type": "string", "description": "| Source." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "POST": { "type": "string", "description": "| Position ||" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "OPENED": { "type": "boolean", "description": "| Is it available to everyone? Possible values:" }, "EXPORT": { "type": "boolean", "description": "| Is the contact included in the export? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the item." }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the main company for the contact." }, "COMPANY_IDS": { "type": "string", "description": "| Array of identifiers of companies associated with the contact." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google Ads, Microsoft Advertising, etc.) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search condition. For example, keywords for contextual advertising ||" }, "TRACE": { "type": "string", "description": "| Information for Sales Intelligence ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "LINK": { "type": "string", "description": "| Links. Service field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this contact ||" }, "ORIGIN_ID": { "type": "string", "description": "| Version of the contact data in the external system. Used to protect data from accidental overwriting by the external system." }, "ORIGIN_VERSION": { "type": "string", "description": "| Original version ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date." }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date." }, "CREATED_BY_ID": { "type": "string", "description": "| Created by." }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by." }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Location address identifier ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of adding a contact be registered in the live feed? Possible values:" }, "IMPORT": { "type": "boolean", "description": "| Is import mode enabled? Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.add": { "post": { "summary": "Add a Company to the Specified Contact crm.contact.company.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.add` adds a company to the specified contact.", "operationId": "crm_contact_company_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "fields": { "type": "object", "description": "| Object format:" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company that will be linked to the contact." }, "IS_PRIMARY": { "type": "boolean", "description": "| Indicates whether the link is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "fields", "COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "fields": { "type": "object", "description": "| Object format:" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company that will be linked to the contact." }, "IS_PRIMARY": { "type": "boolean", "description": "| Indicates whether the link is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "fields", "COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.delete": { "post": { "summary": "Remove a company from the specified contact crm.contact.company.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.delete` removes a company from the specified contact.", "operationId": "crm_contact_company_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "fields": { "type": "object", "description": "| An object containing information about which company needs to be removed from the bindings." }, "fields.COMPANY_ID": { "type": "integer", "description": "| Identifier of the company that needs to be removed from the bindings ||" } }, "required": [ "id", "fields", "fields.COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "fields": { "type": "object", "description": "| An object containing information about which company needs to be removed from the bindings." }, "fields.COMPANY_ID": { "type": "integer", "description": "| Identifier of the company that needs to be removed from the bindings ||" } }, "required": [ "id", "fields", "fields.COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.fields": { "post": { "summary": "Get Fields for Contact-Company crm.contact.company.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.fields` returns the description of fields for the contact-company relationship. No parameters.", "operationId": "crm_contact_company_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Object in the format:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Object in the format:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.delete": { "post": { "summary": "Clear the set of companies associated with the specified contact crm.contact.company.items.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.items.delete` clears the set of companies associated with the specified contact.", "operationId": "crm_contact_company_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-items-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.get": { "post": { "summary": "Get a set of companies associated with the specified contact crm.contact.company.items.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.items.get` returns a set of companies associated with the specified contact.", "operationId": "crm_contact_company_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-items-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.company.items.set": { "post": { "summary": "Set the set of companies associated with the specified contact crm.contact.company.items.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.company.items.set` sets the set of companies associated with the specified contact.", "operationId": "crm_contact_company_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/company/crm-contact-company-items-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "items": { "type": "string", "description": "| A set of objects that describe the associated companies for the contact. The structure of an individual binding object is described below ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company that will be associated with the contact." }, "IS_PRIMARY": { "type": "boolean", "description": "| Indicates whether the binding is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "items", "COMPANY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact." }, "items": { "type": "string", "description": "| A set of objects that describe the associated companies for the contact. The structure of an individual binding object is described below ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company that will be associated with the contact." }, "IS_PRIMARY": { "type": "boolean", "description": "| Indicates whether the binding is primary. Possible values:" }, "SORT": { "type": "integer", "description": "| Sort index." } }, "required": [ "id", "items", "COMPANY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.delete": { "post": { "summary": "Delete Contact crm.contact.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.contact.delete` removes a contact and all associated objects.", "operationId": "crm_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the contact." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the contact." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Set a Common Contact Card for All Users crm.contact.details.configuration.forceCommonScopeForAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). This method allows you to enforce a common contact card for all users. No parameters required.", "operationId": "crm_contact_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-force-common-scope-for-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Root element of the response." }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Root element of the response." }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.get": { "post": { "summary": "Get Parameters of crm.contact.details.configuration.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). This method retrieves the settings for contact cards: it reads the personal settings of the specified user or the shared settings defined for all users.", "operationId": "crm_contact_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when requesting another user's personal settings." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when requesting another user's personal settings." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.reset": { "post": { "summary": "Resetting the Parameters of crm.contact.details.configuration.reset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). This method resets the contact card settings: it removes the personal settings of the specified user or the shared settings defined for all users.", "operationId": "crm_contact_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-reset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when resetting personal settings." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when resetting personal settings." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.details.configuration.set": { "post": { "summary": "Set Parameters for the Individual Card crm.contact.details.configuration.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). This method sets the contact card settings: it writes personal settings for the specified user or shared settings for all users.", "operationId": "crm_contact_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/custom-form/crm-contact-details-configuration-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when setting personal settings." }, "data": { "type": "string", "description": "| The list of `section` describes the configuration of field sections in the item card." }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section." }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| The array `section_element` describes the configuration of fields in the section." }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional list of options for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier for the default address type. To find possible address types, use `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Whether the payment acceptance button is displayed." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Whether the \"Payment and Delivery\" block is displayed." } }, "required": [ "data", "name", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when setting personal settings." }, "data": { "type": "string", "description": "| The list of `section` describes the configuration of field sections in the item card." }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section." }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| The array `section_element` describes the configuration of fields in the section." }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional list of options for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier for the default address type. To find possible address types, use `crm.enum.addresstype` ||" }, "defaultCountry": { "type": "string", "description": "|" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Whether the payment acceptance button is displayed." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Whether the \"Payment and Delivery\" block is displayed." } }, "required": [ "data", "name", "title", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.fields": { "post": { "summary": "Get Contact Fields crm.contact.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). This method returns the description of contact fields, including custom fields. No parameters are required.", "operationId": "crm_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.get": { "post": { "summary": "Get Contact by Id crm.contact.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.contact.get` returns a contact by its identifier. To retrieve a list of companies associated with the contact, use the method [`crm.contact.company.items.get`](company/crm-contact-company-items-get.md).", "operationId": "crm_contact_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact. Can be obtained using the methods `crm.contact.list` or `crm.contact.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the contact. Can be obtained using the methods `crm.contact.list` or `crm.contact.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.list": { "post": { "summary": "Get a List of Contacts crm.contact.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.contact.list` returns a list of contacts based on a filter. It is an implementation of the list method for contacts. To retrieve a list of companies associated with a contact, use the method [`crm.contact.company.items.get`](company/crm-contact-company-items-get.md).", "operationId": "crm_contact_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated for the contacts in the selection." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| A parameter for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated for the contacts in the selection." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| A parameter for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.update": { "post": { "summary": "Update Contact crm.contact.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been discontinued. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.contact.update` updates an existing contact. It is recommended to pass the complete set of address fields when updating an address.", "operationId": "crm_contact_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/crm-contact-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the contact to be changed." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters." }, "HONORIFIC": { "type": "string", "description": "| Salutation." }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "PHOTO": { "type": "string", "description": "| Photograph ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Date of birth ||" }, "TYPE_ID": { "type": "string", "description": "| Contact type." }, "SOURCE_ID": { "type": "string", "description": "| Source" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "POST": { "type": "string", "description": "| Position ||" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "OPENED": { "type": "boolean", "description": "| Is it available to everyone? Possible values:" }, "EXPORT": { "type": "boolean", "description": "| Is the contact participating in the export? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the item ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the main company for the contact." }, "COMPANY_IDS": { "type": "string", "description": "| Array of identifiers of companies to which the contact is linked." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google Ads, Microsoft Advertising, etc.) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "LINK": { "type": "string", "description": "| Links. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this contact ||" }, "ORIGIN_ID": { "type": "string", "description": "| Version of the contact data in the external system. Used to protect data from accidental overwriting by the external system." }, "ORIGIN_VERSION": { "type": "string", "description": "| Version of the original ||" }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Location address identifier ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the update event of the contact be registered in the activity stream? Possible values:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should the update of the contact be registered in the history? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the contact to be changed." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| An object containing a set of additional parameters." }, "HONORIFIC": { "type": "string", "description": "| Salutation." }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "PHOTO": { "type": "string", "description": "| Photograph ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Date of birth ||" }, "TYPE_ID": { "type": "string", "description": "| Contact type." }, "SOURCE_ID": { "type": "string", "description": "| Source" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "POST": { "type": "string", "description": "| Position ||" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "OPENED": { "type": "boolean", "description": "| Is it available to everyone? Possible values:" }, "EXPORT": { "type": "boolean", "description": "| Is the contact participating in the export? Possible values:" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the user responsible for the item ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the main company for the contact." }, "COMPANY_IDS": { "type": "string", "description": "| Array of identifiers of companies to which the contact is linked." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google Ads, Microsoft Advertising, etc.) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "PHONE": { "type": "string", "description": "| Phone ||" }, "EMAIL": { "type": "string", "description": "| E-mail ||" }, "WEB": { "type": "string", "description": "| Website ||" }, "IM": { "type": "string", "description": "| Messenger ||" }, "LINK": { "type": "string", "description": "| Links. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external system that is the source of data about this contact ||" }, "ORIGIN_ID": { "type": "string", "description": "| Version of the contact data in the external system. Used to protect data from accidental overwriting by the external system." }, "ORIGIN_VERSION": { "type": "string", "description": "| Version of the original ||" }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_LOC_ADDR_ID": { "type": "integer", "description": "| Location address identifier ||" }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the update event of the contact be registered in the activity stream? Possible values:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should the update of the contact be registered in the history? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.add": { "post": { "summary": "Create a Custom Field for Contacts crm.contact.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.userfield.add` creates a new custom field for contacts.", "operationId": "crm_contact_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/userfield/crm-contact-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| The data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help." }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type (`USER_TYPE_ID`) has its own set of available settings, which are described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`. For custom fields of other types, this parameter is meaningless." }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| The data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help." }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type (`USER_TYPE_ID`) has its own set of available settings, which are described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`. For custom fields of other types, this parameter is meaningless." }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.delete": { "post": { "summary": "Delete Custom Contact Field crm.contact.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.userfield.delete` removes a custom contact field.", "operationId": "crm_contact_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/userfield/crm-contact-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the contact." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the contact." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.get": { "post": { "summary": "Get Custom Contact Field by Id crm.contact.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.userfield.get` returns a custom contact field by its identifier.", "operationId": "crm_contact_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/userfield/crm-contact-userfield-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the contact." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the contact." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.list": { "post": { "summary": "Get a list of custom fields for contacts crm.contact.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.userfield.list` returns a list of custom fields for contacts based on a filter. It also outputs information about these fields, but without the name assigned to the field by the user, only the internal identifier. If you need the user-defined field name, use the method [crm.contact.list](../crm-contact-list.md), which outputs both standard and custom fields.", "operationId": "crm_contact_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/userfield/crm-contact-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the custom field multiple (`Y` — yes / `N` — no) ||" }, "MANDATORY": { "type": "boolean", "description": "| Is the custom field mandatory (`Y` — yes / `N` — no) ||" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show in the list (`Y` — yes / `N` — no)." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing (`Y` — yes / `N` — no) ||" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are field values included in the search (`Y` — yes / `N` — no)" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the custom field multiple (`Y` — yes / `N` — no) ||" }, "MANDATORY": { "type": "boolean", "description": "| Is the custom field mandatory (`Y` — yes / `N` — no) ||" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show in the list (`Y` — yes / `N` — no)." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing (`Y` — yes / `N` — no) ||" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are field values included in the search (`Y` — yes / `N` — no)" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.contact.userfield.update": { "post": { "summary": "Update Existing Custom Contact Field crm.contact.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.contact.userfield.update` updates an existing custom contact field.", "operationId": "crm_contact_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/contacts/userfield/crm-contact-userfield-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type (`USER_TYPE_ID`) has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for a custom field of type `enumeration`. This parameter is meaningless for custom fields of other types ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message." }, "ID": { "type": "string", "description": "| Identifier of the list item. When passing this parameter, the corresponding list item will be changed; otherwise, a new list item will be added." }, "DEL": { "type": "boolean", "description": "| Flag necessary for deleting a list item. Makes sense only when passing `ID`." }, "VALUE": { "type": "string", "description": "| Value of the list item ||" }, "DEF": { "type": "boolean", "description": "| Is the list item the default value? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type (`USER_TYPE_ID`) has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for a custom field of type `enumeration`. This parameter is meaningless for custom fields of other types ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message." }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message." }, "ID": { "type": "string", "description": "| Identifier of the list item. When passing this parameter, the corresponding list item will be changed; otherwise, a new list item will be added." }, "DEL": { "type": "boolean", "description": "| Flag necessary for deleting a list item. Makes sense only when passing `ID`." }, "VALUE": { "type": "string", "description": "| Value of the list item ||" }, "DEF": { "type": "boolean", "description": "| Is the list item the default value? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.add": { "post": { "summary": "Add Currency crm.currency.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new currency. For the languages used on the account, localization parameters must be specified. If not provided, [default parameters](../data-types.md#crm_currency_localization) will be used. Localization parameters for a specific language can be set using the [crm.currency.localizations.set](./localizations/crm-currency-localizations-set.md) method.", "operationId": "crm_currency_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new currency in the form of a structure:" }, "CURRENCY": { "type": "string", "description": "| Currency identifier." }, "BASE": { "type": "string", "description": "| Indicates whether the currency is base." }, "AMOUNT_CNT": { "type": "integer", "description": "| Denomination. Typically, `1` or a multiple of `10` is used as the denomination." }, "AMOUNT": { "type": "number", "format": "double", "description": "| Exchange rate relative to the base currency. ||" }, "SORT": { "type": "integer", "description": "| Position in the currency list." }, "LANG": { "type": "object", "description": "| Currency localization parameters." }, "DECIMALS": { "type": "integer", "description": "| Number of decimal places in the fractional part. ||" }, "DEC_POINT": { "type": "string", "description": "| Decimal point for output. ||" }, "FORMAT_STRING": { "type": "string", "description": "| Format template. ||" }, "FULL_NAME": { "type": "string", "description": "| Name of the currency in the language for which localization is added. ||" }, "HIDE_ZERO": { "type": "string", "description": "| Indicates whether to hide insignificant zeros. ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Thousands separator. ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Code for the thousands separator." } }, "required": [ "fields", "CURRENCY", "AMOUNT_CNT", "AMOUNT", "DECIMALS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new currency in the form of a structure:" }, "CURRENCY": { "type": "string", "description": "| Currency identifier." }, "BASE": { "type": "string", "description": "| Indicates whether the currency is base." }, "AMOUNT_CNT": { "type": "integer", "description": "| Denomination. Typically, `1` or a multiple of `10` is used as the denomination." }, "AMOUNT": { "type": "number", "format": "double", "description": "| Exchange rate relative to the base currency. ||" }, "SORT": { "type": "integer", "description": "| Position in the currency list." }, "LANG": { "type": "object", "description": "| Currency localization parameters." }, "DECIMALS": { "type": "integer", "description": "| Number of decimal places in the fractional part. ||" }, "DEC_POINT": { "type": "string", "description": "| Decimal point for output. ||" }, "FORMAT_STRING": { "type": "string", "description": "| Format template. ||" }, "FULL_NAME": { "type": "string", "description": "| Name of the currency in the language for which localization is added. ||" }, "HIDE_ZERO": { "type": "string", "description": "| Indicates whether to hide insignificant zeros. ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Thousands separator. ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Code for the thousands separator." } }, "required": [ "fields", "CURRENCY", "AMOUNT_CNT", "AMOUNT", "DECIMALS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.base.get": { "post": { "summary": "Get the Symbolic Identifier of the Base Currency crm.currency.base.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the symbolic identifier of the base currency. No parameters.", "operationId": "crm_currency_base_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-base-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Identifier of the base currency ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Identifier of the base currency ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.base.set": { "post": { "summary": "Set Currency as Base crm.currency.base.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the base currency. After changing the base currency, it is necessary to update the exchange rates of other currencies relative to the base!", "operationId": "crm_currency_base_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-base-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the currency that will become the base." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the currency that will become the base." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.delete": { "post": { "summary": "Delete Currency crm.currency.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a currency.", "operationId": "crm_currency_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.fields": { "post": { "summary": "Get Currency Fields crm.currency.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the description of currency fields. Each field is described as a field settings structure [crm_rest_field_description](../data-types.md#crm_rest_field_description). No parameters.", "operationId": "crm_currency_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object with a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the crm_currency object field, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object with a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the crm_currency object field, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.get": { "post": { "summary": "Get Currency by ID crm.currency.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves currency data by its symbolic identifier `id` according to ISO 4217. Localization parameters (settings dependent on language) will be returned for the current account language.", "operationId": "crm_currency_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the currency." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the currency." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.list": { "post": { "summary": "Get the list of currencies crm.currency.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the list of currencies created on the account. Localization parameters (settings dependent on language) will be returned for the current language of the account.", "operationId": "crm_currency_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, where `field_N` is the identifier of the crm_currency." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, where `field_N` is the identifier of the crm_currency." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.delete": { "post": { "summary": "Delete currency localizations crm.currency.localizations.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes currency localizations for the specified languages.", "operationId": "crm_currency_localizations_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/localizations/crm-currency-localizations-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." }, "lids": { "type": "array", "items": {}, "description": "| Array of language identifiers for which localizations need to be deleted ||" } }, "required": [ "id", "lids" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." }, "lids": { "type": "array", "items": {}, "description": "| Array of language identifiers for which localizations need to be deleted ||" } }, "required": [ "id", "lids" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.fields": { "post": { "summary": "Get Currency Localization Fields crm.currency.localizations.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available currency localization fields, which are settings dependent on the language. No parameters.", "operationId": "crm_currency_localizations_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/localizations/crm-currency-localizations-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object containing a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the crm_currency_localization object, and `value` is an object of type crm_rest_field_description. ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object containing a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the crm_currency_localization object, and `value` is an object of type crm_rest_field_description. ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.get": { "post": { "summary": "Get Currency Localizations crm.currency.localizations.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves existing currency localizations.", "operationId": "crm_currency_localizations_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/localizations/crm-currency-localizations-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Currency identifier." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.localizations.set": { "post": { "summary": "Set Localizations for Currency crm.currency.localizations.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates localizations for a currency or adds them if the localization for the specified language does not exist.", "operationId": "crm_currency_localizations_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/localizations/crm-currency-localizations-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "/" }, "id": { "type": "string", "description": "| Currency identifier." }, "localizations": { "type": "object", "description": "| Currency localization parameters." } }, "required": [ "id", "localizations" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "/" }, "id": { "type": "string", "description": "| Currency identifier." }, "localizations": { "type": "object", "description": "| Currency localization parameters." } }, "required": [ "id", "localizations" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.currency.update": { "post": { "summary": "Update Currency crm.currency.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing currency.", "operationId": "crm_currency_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/currency/crm-currency-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Currency identifier." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the currency in the following structure:" }, "SORT": { "type": "integer", "description": "| Position in the currency list." }, "AMOUNT_CNT": { "type": "integer", "description": "| Denomination. Typically, `1` or a multiple of `10` is used as the denomination." }, "AMOUNT": { "type": "number", "format": "double", "description": "| Exchange rate relative to the base currency. ||" }, "BASE": { "type": "string", "description": "| Indicates whether the currency is a base currency." }, "LANG": { "type": "object", "description": "| Currency localization parameters." }, "DECIMALS": { "type": "integer", "description": "| Number of decimal places in the fractional part. ||" }, "DEC_POINT": { "type": "string", "description": "| Decimal point for output. ||" }, "FORMAT_STRING": { "type": "string", "description": "| Format template. ||" }, "FULL_NAME": { "type": "string", "description": "| Name of the currency in the language for which localization is added. ||" }, "HIDE_ZERO": { "type": "string", "description": "| Indicates whether to hide insignificant zeros. ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Thousands separator. ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Code for the thousands separator." } }, "required": [ "AMOUNT_CNT", "AMOUNT", "DECIMALS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Currency identifier." }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the currency in the following structure:" }, "SORT": { "type": "integer", "description": "| Position in the currency list." }, "AMOUNT_CNT": { "type": "integer", "description": "| Denomination. Typically, `1` or a multiple of `10` is used as the denomination." }, "AMOUNT": { "type": "number", "format": "double", "description": "| Exchange rate relative to the base currency. ||" }, "BASE": { "type": "string", "description": "| Indicates whether the currency is a base currency." }, "LANG": { "type": "object", "description": "| Currency localization parameters." }, "DECIMALS": { "type": "integer", "description": "| Number of decimal places in the fractional part. ||" }, "DEC_POINT": { "type": "string", "description": "| Decimal point for output. ||" }, "FORMAT_STRING": { "type": "string", "description": "| Format template. ||" }, "FULL_NAME": { "type": "string", "description": "| Name of the currency in the language for which localization is added. ||" }, "HIDE_ZERO": { "type": "string", "description": "| Indicates whether to hide insignificant zeros. ||" }, "THOUSANDS_SEP": { "type": "string", "description": "| Thousands separator. ||" }, "THOUSANDS_VARIANT": { "type": "string", "description": "| Code for the thousands separator." } }, "required": [ "AMOUNT_CNT", "AMOUNT", "DECIMALS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.add": { "post": { "summary": "Create a New Deal crm.deal.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.deal.add` creates a new deal.", "operationId": "crm_deal_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object containing an additional set of parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Deal title." }, "TYPE_ID": { "type": "string", "description": "| String identifier of the deal type." }, "CATEGORY_ID": { "type": "string", "description": "| Funnel identifier. Must be greater than or equal to 0." }, "STAGE_ID": { "type": "string", "description": "| Deal stage." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a template for a recurring deal. Possible values:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeat. Possible values:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeated approach. Possible values:" }, "PROBABILITY": { "type": "integer", "description": "| Probability, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount." }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicates whether manual calculation of the amount is enabled. Possible values:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount." }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company associated with the deal." }, "CONTACT_ID": { "type": "string", "description": "| Contact. Deprecated ||" }, "CONTACT_IDS": { "type": "string", "description": "| List of contacts associated with the deal." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Start date." }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Close date." }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the deal available to everyone? Possible values:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Is the deal closed? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports bb-codes ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person." }, "SOURCE_ID": { "type": "string", "description": "| String identifier of the source type." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Additional information ||" }, "LOCATION_ID": { "type": "string", "description": "| Client's location. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google-Adwords and others) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search term. For example, keywords for contextual advertising ||" }, "TRACE": { "type": "string", "description": "| Information for Sales Intelligence — read more in the article {#T} ||" }, "UF_CRM_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Relationship fields." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of adding a deal be registered in the activity stream? Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object containing an additional set of parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Deal title." }, "TYPE_ID": { "type": "string", "description": "| String identifier of the deal type." }, "CATEGORY_ID": { "type": "string", "description": "| Funnel identifier. Must be greater than or equal to 0." }, "STAGE_ID": { "type": "string", "description": "| Deal stage." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a template for a recurring deal. Possible values:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeat. Possible values:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeated approach. Possible values:" }, "PROBABILITY": { "type": "integer", "description": "| Probability, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount." }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicates whether manual calculation of the amount is enabled. Possible values:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount." }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the company associated with the deal." }, "CONTACT_ID": { "type": "string", "description": "| Contact. Deprecated ||" }, "CONTACT_IDS": { "type": "string", "description": "| List of contacts associated with the deal." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Start date." }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Close date." }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the deal available to everyone? Possible values:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Is the deal closed? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports bb-codes ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person." }, "SOURCE_ID": { "type": "string", "description": "| String identifier of the source type." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Additional information ||" }, "LOCATION_ID": { "type": "string", "description": "| Client's location. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google-Adwords and others) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Traffic type. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Campaign content. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Campaign search term. For example, keywords for contextual advertising ||" }, "TRACE": { "type": "string", "description": "| Information for Sales Intelligence — read more in the article {#T} ||" }, "UF_CRM_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Relationship fields." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of adding a deal be registered in the activity stream? Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.add": { "post": { "summary": "Add Contact to Deal crm.deal.contact.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing here — we will complete it soon. - parameter types are not specified - parameter requirements are not specified", "operationId": "crm_deal_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the deal. ||" }, "fields": { "type": "string", "description": "| An object with the following fields:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the deal. ||" }, "fields": { "type": "string", "description": "| An object with the following fields:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.delete": { "post": { "summary": "Remove Contact from Specified Deal crm.deal.contact.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing here — we will complete it soon. - parameter types are not specified - examples are missing", "operationId": "crm_deal_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "fields": { "type": "string", "description": "| An object with the following fields:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "fields": { "type": "string", "description": "| An object with the following fields:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.fields": { "post": { "summary": "Get Fields for Deal-Contact Connection crm.deal.contact.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing here — we will fill it in shortly. - examples are missing (in other languages) - success response is missing", "operationId": "crm_deal_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "SORT": { "type": "integer", "description": "| Sort index (number). Determines the order in which linked contacts will be displayed in the deal. ||" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| [Y/N] Indicates whether the binding is primary. There is always a primary contact in the deal. For it, `IS_PRIMARY=Y`, for others `IS_PRIMARY=N`. ||" }, "CONTACT_ID": { "type": "integer", "description": "| Identifier of the contact linked to the deal (number). ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Description ||" }, "SORT": { "type": "integer", "description": "| Sort index (number). Determines the order in which linked contacts will be displayed in the deal. ||" }, "IS_PRIMARY": { "type": "string", "maxLength": 1, "description": "| [Y/N] Indicates whether the binding is primary. There is always a primary contact in the deal. For it, `IS_PRIMARY=Y`, for others `IS_PRIMARY=N`. ||" }, "CONTACT_ID": { "type": "integer", "description": "| Identifier of the contact linked to the deal (number). ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.delete": { "post": { "summary": "Delete the set of contacts associated with the specified deal crm.deal.contact.items.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing — we will complete it shortly. - parameter type is not specified - examples are missing (in other languages)", "operationId": "crm_deal_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-items-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.get": { "post": { "summary": "Get a set of contacts associated with a deal crm.deal.contact.items.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing — we will complete it shortly. - parameter type is not specified - examples are missing (in other languages)", "operationId": "crm_deal_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-items-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "Field": { "type": "string", "description": "| Description ||" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact ||" }, "SORT": { "type": "string", "description": "| Sort index ||" }, "ROLE_ID": { "type": "string", "description": "| Identifier of the role (reserved) ||" }, "IS_PRIMARY": { "type": "string", "description": "| Flag for primary contact ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "Field": { "type": "string", "description": "| Description ||" }, "CONTACT_ID": { "type": "string", "description": "| Identifier of the contact ||" }, "SORT": { "type": "string", "description": "| Sort index ||" }, "ROLE_ID": { "type": "string", "description": "| Identifier of the role (reserved) ||" }, "IS_PRIMARY": { "type": "string", "description": "| Flag for primary contact ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.contact.items.set": { "post": { "summary": "Add Multiple Contacts to a Deal crm.deal.contact.items.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing — we will complete it shortly. - parameter types are not specified - parameter requirements are not indicated", "operationId": "crm_deal_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/contacts/crm-deal-contact-items-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the deal. ||" }, "items": { "type": "string", "description": "| A collection of contacts represented as an array of objects with the following fields:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the deal. ||" }, "items": { "type": "string", "description": "| A collection of contacts represented as an array of objects with the following fields:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.delete": { "post": { "summary": "Delete Deal crm.deal.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.deal.delete` removes a deal and all associated objects. Deleting a deal will result in the removal of all related objects, such as CRM activities, history, Timeline activities, and others.", "operationId": "crm_deal_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Set a Common Detail Form for All Users crm.deal.details.configuration.forceCommonScopeForAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.deal.details.configuration.forceCommonScopeForAll` forcibly sets a common deal detail form for all users and removes their personal settings. The settings for deal detail forms may vary across different Sales Funnels. To select a Sales Funnel, use the `extras.dealCategoryId` parameter.", "operationId": "crm_deal_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/custom-form/crm-deal-details-configuration-force-common-scope-for-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the Sales Funnel. Can be obtained using crm.category.list" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the Sales Funnel. Can be obtained using crm.category.list" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.get": { "post": { "summary": "Get Parameters of the Deal Card crm.deal.details.configuration.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.deal.details.configuration.get` retrieves the settings of the deal card. It reads the personal settings of the specified user or the shared settings defined for all users. The settings of deal cards may vary across different Sales Funnels. To select a funnel, use the `extras.dealCategoryId` parameter.", "operationId": "crm_deal_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/custom-form/crm-deal-details-configuration-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when requesting personal settings of another user." }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the deal funnel. Can be obtained using crm.category.list" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when requesting personal settings of another user." }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the deal funnel. Can be obtained using crm.category.list" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.reset": { "post": { "summary": "Reset Deal Card Settings crm.deal.details.configuration.reset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.deal.details.configuration.reset` resets the settings of the deal card. It removes the personal settings of the specified user or the common settings defined for all users. The settings of deal cards in different Sales Funnels may vary. To select a Sales Funnel, use the `extras.dealCategoryId` parameter.", "operationId": "crm_deal_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/custom-form/crm-deal-details-configuration-reset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when resetting another user's personal settings." }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the Sales Funnel. Can be obtained using crm.category.list" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when resetting another user's personal settings." }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the Sales Funnel. Can be obtained using crm.category.list" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.details.configuration.set": { "post": { "summary": "Set Parameters for the Deal Card crm.deal.details.configuration.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.deal.details.configuration.set` sets the settings for the deal card. It records the personal settings for the specified user or the general settings for all users. The settings for deal cards in different Sales Funnels may vary. To select a Sales Funnel, use the `extras.dealCategoryId` parameter.", "operationId": "crm_deal_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/custom-form/crm-deal-details-configuration-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when setting personal settings for another user." }, "data": { "type": "string", "description": "| A list of `section` describing the configuration of the deal card sections. The structure of `section` is described below ||" }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the deal funnel. Can be obtained using crm.category.list" }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section ||" }, "type": { "type": "string", "description": "| Type of the section" }, "elements": { "type": "string", "description": "| List of fields displayed in the card with additional settings ||" }, "optionFlags": { "type": "integer", "description": "| Whether to always show the field:" }, "options": { "type": "object", "description": "| Additional options for the field. The composition depends on the field ||" } }, "required": [ "data", "name", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The scope of the settings." }, "userId": { "type": "string", "description": "| User identifier. Required only when setting personal settings for another user." }, "data": { "type": "string", "description": "| A list of `section` describing the configuration of the deal card sections. The structure of `section` is described below ||" }, "extras": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "dealCategoryId": { "type": "integer", "description": "| Identifier of the deal funnel. Can be obtained using crm.category.list" }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section ||" }, "type": { "type": "string", "description": "| Type of the section" }, "elements": { "type": "string", "description": "| List of fields displayed in the card with additional settings ||" }, "optionFlags": { "type": "integer", "description": "| Whether to always show the field:" }, "options": { "type": "object", "description": "| Additional options for the field. The composition depends on the field ||" } }, "required": [ "data", "name", "title", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.fields": { "post": { "summary": "Get Fields of the Deal crm.deal.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.deal.fields` returns the description of deal fields, including custom fields. A table with the description of standard fields can be found in the article [Fields of Main CRM Entities](../main-entities-fields.md).", "operationId": "crm_deal_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.get": { "post": { "summary": "Get Deal by Id crm.deal.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.deal.get` returns a deal by its identifier.", "operationId": "crm_deal_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.list": { "post": { "summary": "Get a List of Deals crm.deal.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.deal.list` returns a list of deals based on a filter. It is an implementation of the list method for deals.", "operationId": "crm_deal_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated for deals in the selection." }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated for deals in the selection." }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.productrows.get": { "post": { "summary": "Get Deal Products crm.deal.productrows.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.deal.productrows.get` returns the product rows of a deal.", "operationId": "crm_deal_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-productrows-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| The root element of the response containing an array of product rows for the deal ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "ID": { "type": "integer", "description": "| The identifier of the product row ||" }, "OWNER_ID": { "type": "integer", "description": "| The identifier of the entity to which the product is linked. For this method, it will always equal the `id` of the deal ||" }, "OWNER_TYPE": { "type": "string", "description": "| String identifier of the type of object to which the product is linked. For this method, it will always equal `D` ||" }, "PRODUCT_ID": { "type": "integer", "description": "| The identifier of the product in the catalog. `0` if not from the catalog" }, "PRODUCT_NAME": { "type": "string", "description": "| The name of the product row ||" }, "ORIGINAL_PRODUCT_NAME": { "type": "string", "description": "| The name of the product row in the catalog ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| The description of the product row ||" }, "PRICE": { "type": "number", "format": "double", "description": "| The total cost of the product per unit ||" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| The cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| The cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| The cost per unit excluding discounts but including taxes ||" }, "PRICE_ACCOUNT": { "type": "string", "description": "| The cost of the product in \"report currency\" ||" }, "QUANTITY": { "type": "integer", "description": "| The quantity of the product units ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| The type of discount" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| The discount value in percentage (if using the percentage discount type) ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| The absolute value of the discount (if using the absolute discount type) ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| The tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "CUSTOMIZED": { "type": "string", "maxLength": 1, "description": "| Customized (Deprecated)" }, "MEASURE_CODE": { "type": "string", "description": "| The code of the unit of measure ||" }, "MEASURE_NAME": { "type": "string", "description": "| The textual representation of the unit of measure (e.g., pcs, kg, m, l, etc.) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "XML_ID": { "type": "string", "description": "| The external code of the product ||" }, "TYPE": { "type": "integer", "description": "| The type of product" }, "STORE_ID": { "type": "integer", "description": "| The identifier of the warehouse. For more detailed information about the warehouse, use `catalog.store.get` ||" }, "RESERVE_ID": { "type": "integer", "description": "| The identifier of the reserve ||" }, "DATE_RESERVE_END": { "type": "string", "format": "date", "description": "| The date of the end of the reservation ||" }, "RESERVE_QUANTITY": { "type": "integer", "description": "| The quantity of reserved product units ||" }, "Description": { "type": "string", "description": "| Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| The root element of the response containing an array of product rows for the deal ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "ID": { "type": "integer", "description": "| The identifier of the product row ||" }, "OWNER_ID": { "type": "integer", "description": "| The identifier of the entity to which the product is linked. For this method, it will always equal the `id` of the deal ||" }, "OWNER_TYPE": { "type": "string", "description": "| String identifier of the type of object to which the product is linked. For this method, it will always equal `D` ||" }, "PRODUCT_ID": { "type": "integer", "description": "| The identifier of the product in the catalog. `0` if not from the catalog" }, "PRODUCT_NAME": { "type": "string", "description": "| The name of the product row ||" }, "ORIGINAL_PRODUCT_NAME": { "type": "string", "description": "| The name of the product row in the catalog ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| The description of the product row ||" }, "PRICE": { "type": "number", "format": "double", "description": "| The total cost of the product per unit ||" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| The cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| The cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| The cost per unit excluding discounts but including taxes ||" }, "PRICE_ACCOUNT": { "type": "string", "description": "| The cost of the product in \"report currency\" ||" }, "QUANTITY": { "type": "integer", "description": "| The quantity of the product units ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| The type of discount" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| The discount value in percentage (if using the percentage discount type) ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| The absolute value of the discount (if using the absolute discount type) ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| The tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "CUSTOMIZED": { "type": "string", "maxLength": 1, "description": "| Customized (Deprecated)" }, "MEASURE_CODE": { "type": "string", "description": "| The code of the unit of measure ||" }, "MEASURE_NAME": { "type": "string", "description": "| The textual representation of the unit of measure (e.g., pcs, kg, m, l, etc.) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "XML_ID": { "type": "string", "description": "| The external code of the product ||" }, "TYPE": { "type": "integer", "description": "| The type of product" }, "STORE_ID": { "type": "integer", "description": "| The identifier of the warehouse. For more detailed information about the warehouse, use `catalog.store.get` ||" }, "RESERVE_ID": { "type": "integer", "description": "| The identifier of the reserve ||" }, "DATE_RESERVE_END": { "type": "string", "format": "date", "description": "| The date of the end of the reservation ||" }, "RESERVE_QUANTITY": { "type": "integer", "description": "| The quantity of reserved product units ||" }, "Description": { "type": "string", "description": "| Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.productrows.set": { "post": { "summary": "Set Products in Deal crm.deal.productrows.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.deal.productrows.set` creates or updates the product rows of a deal. Existing rows that are not passed to the method will be removed from the deal. To modify only one row, use the methods [crm.item.productrow.*](../universal/product-rows/index.md).", "operationId": "crm_deal_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-productrows-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Product rows" }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog. The list of products can be obtained using the method `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row. If `PRODUCT_ID` is provided, the name will be taken from the product" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts but including taxes ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Quantity of product units" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Type of discount" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage (if percentage discount type is used)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value (if absolute discount type is used)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.)" }, "SORT": { "type": "integer", "description": "| Sorting" }, "result": { "type": "boolean", "description": "| Root element of the response, contains `true` in case of success ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Description": { "type": "string", "description": "| Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Product rows" }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog. The list of products can be obtained using the method `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row. If `PRODUCT_ID` is provided, the name will be taken from the product" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts but including taxes ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Quantity of product units" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Type of discount" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage (if percentage discount type is used)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value (if absolute discount type is used)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.)" }, "SORT": { "type": "integer", "description": "| Sorting" }, "result": { "type": "boolean", "description": "| Root element of the response, contains `true` in case of success ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Description": { "type": "string", "description": "| Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.add": { "post": { "summary": "Create a Template for Recurring Deal crm.deal.recurring.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.add` creates a template for a recurring deal based on an existing deal.", "operationId": "crm_deal_recurring_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DEAL_ID": { "type": "integer", "description": "| Identifier of the deal based on which the recurring deal template is created." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity flag of the setting. Possible values:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| ID of the funnel for new deals created from the template." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Limit on creating new deals:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Maximum number of deals that can be created from the template. Used when `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| End date for generating deals from the template in the format `YYYY-MM-DD`. Used when `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Start date for calculating the next run in the format `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Frequency parameters (detailed description) ||" }, "MODE": { "type": "string", "description": "| Repetition mode:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Type of period for `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Repetition interval for `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Offset type for `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Offset value for `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Offset type for the start date of the created deal:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Offset value for the start date of the created deal ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Offset type for the end date of the created deal:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Offset value for the end date of the created deal ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DEAL_ID": { "type": "integer", "description": "| Identifier of the deal based on which the recurring deal template is created." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity flag of the setting. Possible values:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| ID of the funnel for new deals created from the template." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Limit on creating new deals:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Maximum number of deals that can be created from the template. Used when `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| End date for generating deals from the template in the format `YYYY-MM-DD`. Used when `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Start date for calculating the next run in the format `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Frequency parameters (detailed description) ||" }, "MODE": { "type": "string", "description": "| Repetition mode:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| Type of period for `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| Repetition interval for `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| Offset type for `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| Offset value for `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| Offset type for the start date of the created deal:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| Offset value for the start date of the created deal ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| Offset type for the end date of the created deal:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| Offset value for the end date of the created deal ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.delete": { "post": { "summary": "Delete the Recurring Deal Template Setting crm.deal.recurring.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.delete` removes an existing setting for a recurring deal template. It is suitable when you need to delete the record of a recurring deal template if the associated deal no longer exists. To delete a recurring deal template, you can use the method [crm.deal.delete](../crm-deal-delete.md). When using this method, both the deal and the configured recurrence template will be deleted.", "operationId": "crm_deal_recurring_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.expose": { "post": { "summary": "Create a New Deal from the Template crm.deal.recurring.expose", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.expose` creates a new deal based on the template for a recurring deal.", "operationId": "crm_deal_recurring_expose", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-expose.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.fields": { "post": { "summary": "Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.fields` returns a description of the fields for the recurring deal template.", "operationId": "crm_deal_recurring_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.get": { "post": { "summary": "Get Recurring Deal Template Settings by ID crm.deal.recurring.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.get` returns the fields of the recurring deal template settings by its identifier.", "operationId": "crm_deal_recurring_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.list": { "post": { "summary": "Get a List of Recurring Deal Template Settings crm.deal.recurring.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.list` returns a list of recurring deal template settings based on the provided filter.", "operationId": "crm_deal_recurring_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Filter object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Filter object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.recurring.update": { "post": { "summary": "Update the Recurring Deal Template Settings crm.deal.recurring.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.recurring.update` updates an existing recurring deal template setting.", "operationId": "crm_deal_recurring_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/recurring-deals/crm-deal-recurring-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object in the following format:" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| The active flag for the setting. Possible values:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| The ID of the funnel for new deals created from the template." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Limit on creating new deals:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| The maximum number of deals that can be created from the template. Used when `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| The end date for generating deals from the template in the format `YYYY-MM-DD`. Used when `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| The start date for calculating the next run in the format `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Recurrence parameters (detailed description) ||" }, "MODE": { "type": "string", "description": "| The recurrence mode:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| The period type for `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| The recurrence interval for `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| The offset type for `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| The offset value for `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| The offset type for the start date of the created deal:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| The offset value for the start date of the created deal ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| The offset type for the completion date of the created deal:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| The offset value for the completion date of the created deal ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object in the following format:" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| The active flag for the setting. Possible values:" }, "CATEGORY_ID": { "type": "string", "maxLength": 1, "description": "| The ID of the funnel for new deals created from the template." }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Limit on creating new deals:" }, "LIMIT_REPEAT": { "type": "integer", "description": "| The maximum number of deals that can be created from the template. Used when `IS_LIMIT = T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| The end date for generating deals from the template in the format `YYYY-MM-DD`. Used when `IS_LIMIT = D` ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| The start date for calculating the next run in the format `YYYY-MM-DD` ||" }, "PARAMS": { "type": "object", "description": "| Recurrence parameters (detailed description) ||" }, "MODE": { "type": "string", "description": "| The recurrence mode:" }, "MULTIPLE_TYPE": { "type": "string", "description": "| The period type for `MODE = multiple`:" }, "MULTIPLE_INTERVAL": { "type": "integer", "description": "| The recurrence interval for `MODE = multiple` ||" }, "SINGLE_BEFORE_START_DATE_TYPE": { "type": "string", "description": "| The offset type for `MODE = single`:" }, "SINGLE_BEFORE_START_DATE_VALUE": { "type": "integer", "description": "| The offset value for `MODE = single` ||" }, "OFFSET_BEGINDATE_TYPE": { "type": "string", "description": "| The offset type for the start date of the created deal:" }, "OFFSET_BEGINDATE_VALUE": { "type": "integer", "description": "| The offset value for the start date of the created deal ||" }, "OFFSET_CLOSEDATE_TYPE": { "type": "string", "description": "| The offset type for the completion date of the created deal:" }, "OFFSET_CLOSEDATE_VALUE": { "type": "integer", "description": "| The offset value for the completion date of the created deal ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.update": { "post": { "summary": "Update Deal crm.deal.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.deal.update` updates an existing deal.", "operationId": "crm_deal_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/crm-deal-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| A set of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| The title of the deal ||" }, "TYPE_ID": { "type": "string", "description": "| The string identifier of the deal type." }, "STAGE_ID": { "type": "string", "description": "| The stage of the deal." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a template for a recurring deal. Possible values:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeat. Possible values:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeated approach. Possible values:" }, "PROBABILITY": { "type": "integer", "description": "| Probability, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicates whether manual calculation of the amount is enabled. Possible values:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount ||" }, "COMPANY_ID": { "type": "string", "description": "| The identifier of the company associated with the deal." }, "CONTACT_ID": { "type": "string", "description": "| Contact. Deprecated ||" }, "CONTACT_IDS": { "type": "string", "description": "| A list of contacts associated with the deal. The field is completely replaced." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Start date ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| End date ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the deal available to everyone? Possible values:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Is the deal closed? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "SOURCE_ID": { "type": "string", "description": "| The string identifier of the source type." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Additional information ||" }, "LOCATION_ID": { "type": "string", "description": "| Client's location. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google-Adwords and others) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search term of the campaign. For example, keywords for contextual advertising ||" }, "UF_CRM_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Relationship fields." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of the deal change be registered in the live feed? Possible values:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should a record be created in the history? Possible values:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the deal." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "| A set of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| The title of the deal ||" }, "TYPE_ID": { "type": "string", "description": "| The string identifier of the deal type." }, "STAGE_ID": { "type": "string", "description": "| The stage of the deal." }, "IS_RECURRING": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a template for a recurring deal. Possible values:" }, "IS_RETURN_CUSTOMER": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeat. Possible values:" }, "IS_REPEATED_APPROACH": { "type": "string", "maxLength": 1, "description": "| Indicates whether the deal is a repeated approach. Possible values:" }, "PROBABILITY": { "type": "integer", "description": "| Probability, % ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency." }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicates whether manual calculation of the amount is enabled. Possible values:" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount ||" }, "COMPANY_ID": { "type": "string", "description": "| The identifier of the company associated with the deal." }, "CONTACT_ID": { "type": "string", "description": "| Contact. Deprecated ||" }, "CONTACT_IDS": { "type": "string", "description": "| A list of contacts associated with the deal. The field is completely replaced." }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Start date ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| End date ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the deal available to everyone? Possible values:" }, "CLOSED": { "type": "string", "maxLength": 1, "description": "| Is the deal closed? Possible values:" }, "COMMENTS": { "type": "string", "description": "| Comment. Supports BB codes ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "SOURCE_ID": { "type": "string", "description": "| The string identifier of the source type." }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Additional information about the source ||" }, "ADDITIONAL_INFO": { "type": "string", "description": "| Additional information ||" }, "LOCATION_ID": { "type": "string", "description": "| Client's location. System field ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the element in the data source." }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system (Google-Adwords and others) ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. Possible values:" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_TERM": { "type": "string", "description": "| Search term of the campaign. For example, keywords for contextual advertising ||" }, "UF_CRM_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "PARENT_ID_...": { "type": "string", "description": "| Relationship fields." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Should the event of the deal change be registered in the live feed? Possible values:" }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should a record be created in the history? Possible values:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.add": { "post": { "summary": "Create a Custom Field for Deals crm.deal.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.userfield.add` creates a new custom field for deals.", "operationId": "crm_deal_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple? Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` field type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "VALUE": { "type": "string", "description": "| Value of the list item." }, "DEF": { "type": "boolean", "description": "| Is the list item the default value? Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple? Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` field type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "VALUE": { "type": "string", "description": "| Value of the list item." }, "DEF": { "type": "boolean", "description": "| Is the list item the default value? Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.delete": { "post": { "summary": "Delete Custom Field crm.deal.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.userfield.delete` removes a custom field from deals.", "operationId": "crm_deal_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the deal." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the deal." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.get": { "post": { "summary": "Get Custom Deal Field by ID crm.deal.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.userfield.get` returns a custom deal field by its identifier.", "operationId": "crm_deal_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the deal." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the deal." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.list": { "post": { "summary": "Get a list of custom fields for deals crm.deal.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.userfield.list` returns a list of custom fields for deals based on the filter.", "operationId": "crm_deal_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values are searchable. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values are searchable. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the provided language will be returned:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.deal.userfield.update": { "post": { "summary": "Update Existing Custom Field for Deals crm.deal.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.deal.userfield.update` updates an existing custom field for deals.", "operationId": "crm_deal_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/deals/user-defined-fields/crm-deal-userfield-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.add": { "post": { "summary": "Create a New Deal Direction crm.dealcategory.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.category.add](../../universal/category/crm-category-add.md). This method creates a new deal direction.", "operationId": "crm_dealcategory_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating a deal direction." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating a deal direction." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.default.get": { "post": { "summary": "Get Default Deal Category Settings crm.dealcategory.default.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method retrieves the settings for the default deal category. No parameters", "operationId": "crm_dealcategory_default_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-default-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.default.set": { "post": { "summary": "Set Default Deal Category Settings crm.dealcategory.default.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method records the settings for the default deal category.", "operationId": "crm_dealcategory_default_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-default-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Name of the default category ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Name of the default category ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.delete": { "post": { "summary": "Delete Deal Direction crm.dealcategory.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.delete](../../universal/category/crm-category-delete.md). This method deletes a deal direction.", "operationId": "crm_dealcategory_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.fields": { "post": { "summary": "Get Descriptions of Fields for Deal Categories crm.dealcategory.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.category.fields](../../universal/category/crm-category-fields.md). This method returns descriptions of fields for deal categories. No parameters required.", "operationId": "crm_dealcategory_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "ID": { "type": "integer", "description": "| Identifier for the deal category ||" }, "IS_LOCKED": { "type": "string", "maxLength": 1, "description": "| Is locked ||" }, "NAME": { "type": "string", "description": "| Name of the category ||" }, "SORT": { "type": "integer", "description": "| Sorting order ||" } }, "required": [ "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CREATED_DATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "ID": { "type": "integer", "description": "| Identifier for the deal category ||" }, "IS_LOCKED": { "type": "string", "maxLength": 1, "description": "| Is locked ||" }, "NAME": { "type": "string", "description": "| Name of the category ||" }, "SORT": { "type": "integer", "description": "| Sorting order ||" } }, "required": [ "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.get": { "post": { "summary": "Get Deal Direction crm.dealcategory.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.get](../../universal/category/crm-category-get.md). This method returns the deal direction by its identifier.", "operationId": "crm_dealcategory_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.list": { "post": { "summary": "Filter Deal Categories crm.dealcategory.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.list](../../universal/category/crm-category-list.md). This method returns a list of deal categories based on the filter. It is an implementation of list methods for deal categories.", "operationId": "crm_dealcategory_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.stage.list": { "post": { "summary": "Get a List of Deal Stages for the crm.dealcategory.stage.list Endpoint", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method returns a list of deal stages for the direction specified by the identifier. It is equivalent to calling the [`crm.status.list`](../../status/crm-status-list.md) method with the `ENTITY_ID` parameter set to the result of the [`crm.dealcategory.status`](crm-deal-category-status.md) call.", "operationId": "crm_dealcategory_stage_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-stage-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction. If `id = 0` or nothing is specified, it will return the statuses of the \"default\" direction. If `id > 0` for a non-existent direction, it returns nothing ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction. If `id = 0` or nothing is specified, it will return the statuses of the \"default\" direction. If `id > 0` for a non-existent direction, it returns nothing ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.status": { "post": { "summary": "Get the Identifier of the Directory Where Deal Stages are Stored: crm.dealcategory.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method returns the identifier of the directory for storing stages based on the deal direction identifier. The identifier is a string of the format `DEAL_STAGE_[Direction Identifier]`. For example, for a direction with an identifier of 1, the string `\"DEAL_STAGE_1\"` will be returned.", "operationId": "crm_dealcategory_status", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Direction identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Direction identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.dealcategory.update": { "post": { "summary": "Update Deal Direction crm.dealcategory.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.category.update](../../universal/category/crm-category-update.md). This method updates an existing deal direction.", "operationId": "crm_dealcategory_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/category-old/crm-deal-category-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the deal direction." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the direction ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the deal direction." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.add": { "post": { "summary": "Create a New Document crm.documentgenerator.document.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.add` creates a document based on a template for a CRM entity.", "operationId": "crm_documentgenerator_document_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Object with the values of the document fields." }, "stampsEnabled": { "type": "integer", "description": "| Include stamp and signature:" }, "fields": { "type": "object", "description": "| Additional descriptions of document fields for generation." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Object with the values of the document fields." }, "stampsEnabled": { "type": "integer", "description": "| Include stamp and signature:" }, "fields": { "type": "object", "description": "| Additional descriptions of document fields for generation." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.delete": { "post": { "summary": "Delete Document crm.documentgenerator.document.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.delete` removes a document.", "operationId": "crm_documentgenerator_document_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.enablepublicurl": { "post": { "summary": "Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.enablepublicurl` enables or disables the public link for a document.", "operationId": "crm_documentgenerator_document_enablepublicurl", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "| Public link mode:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "| Public link mode:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.get": { "post": { "summary": "Get Document crm.documentgenerator.document.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.get` returns the document data by its identifier.", "operationId": "crm_documentgenerator_document_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.getfields": { "post": { "summary": "Get Document Fields crm.documentgenerator.document.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.getfields` returns a detail form of the fields of an already created document: which fields are available, their current values, default values, and service indicators.", "operationId": "crm_documentgenerator_document_getfields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Object format:" }, "DocumentNumber": { "type": "string", "description": "| Document number ||" }, "DocumentCreateTime": { "type": "string", "description": "| Generation date ||" }, "DocumentTitle": { "type": "string", "description": "| Document title ||" }, "ClientPhone": { "type": "string", "description": "| Client phone ||" }, "ClientEmail": { "type": "string", "description": "| Client email ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Product name ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Quantity ||" }, "TotalSum": { "type": "string", "description": "| Total amount ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| Object format:" }, "DocumentNumber": { "type": "string", "description": "| Document number ||" }, "DocumentCreateTime": { "type": "string", "description": "| Generation date ||" }, "DocumentTitle": { "type": "string", "description": "| Document title ||" }, "ClientPhone": { "type": "string", "description": "| Client phone ||" }, "ClientEmail": { "type": "string", "description": "| Client email ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Product name ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Quantity ||" }, "TotalSum": { "type": "string", "description": "| Total amount ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.list": { "post": { "summary": "Get a List of Documents crm.documentgenerator.document.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.list` returns a list of documents based on the filter.", "operationId": "crm_documentgenerator_document_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated in the documents returned." }, "filter": { "type": "object", "description": "| An object in the following format:" }, "order": { "type": "object", "description": "| An object in the following format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields that should be populated in the documents returned." }, "filter": { "type": "object", "description": "| An object in the following format:" }, "order": { "type": "object", "description": "| An object in the following format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.update": { "post": { "summary": "Update Document crm.documentgenerator.document.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.update` updates an existing document.", "operationId": "crm_documentgenerator_document_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| An object containing the field values of the document." }, "stampsEnabled": { "type": "integer", "description": "| Include stamp and signature:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "values": { "type": "object", "description": "| An object containing the field values of the document." }, "stampsEnabled": { "type": "integer", "description": "| Include stamp and signature:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.document.upload": { "post": { "summary": "Upload Document crm.documentgenerator.document.upload", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.document.upload` uploads a prepared document and attaches it to a CRM entity.", "operationId": "crm_documentgenerator_document_upload", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/documents/crm-document-generator-document-upload.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pdfContent": { "type": "string", "description": "| Content of the PDF file in base64 format." }, "imageContent": { "type": "string", "description": "| Content of the image in base64 format." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "pdfContent": { "type": "string", "description": "| Content of the PDF file in base64 format." }, "imageContent": { "type": "string", "description": "| Content of the image in base64 format." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.add": { "post": { "summary": "Add a New Numerator crm.documentgenerator.numerator.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.numerator.add` creates a new numerator.", "operationId": "crm_documentgenerator_numerator_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with numerator parameters in the following format:" }, "name": { "type": "string", "description": "| The name of the numerator ||" }, "template": { "type": "string", "description": "| The number template, for example `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Generator settings. Parameter descriptions are below. ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering. Parameter descriptions are below ||" }, "start": { "type": "integer", "description": "| The initial value of the counter. Default is `1` ||" }, "step": { "type": "integer", "description": "| The increment step of the counter. Default is `1` ||" }, "length": { "type": "integer", "description": "| The minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| The left padding character when `length > 0`. Default is `'0'` ||" }, "periodicBy": { "type": "string", "description": "| The reset period for the counter:" }, "timezone": { "type": "string", "description": "| The timezone identifier for periodic reset, for example `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Indicator of direct numbering. Default is `false` ||" } }, "required": [ "fields", "name", "template" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with numerator parameters in the following format:" }, "name": { "type": "string", "description": "| The name of the numerator ||" }, "template": { "type": "string", "description": "| The number template, for example `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Generator settings. Parameter descriptions are below. ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering. Parameter descriptions are below ||" }, "start": { "type": "integer", "description": "| The initial value of the counter. Default is `1` ||" }, "step": { "type": "integer", "description": "| The increment step of the counter. Default is `1` ||" }, "length": { "type": "integer", "description": "| The minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| The left padding character when `length > 0`. Default is `'0'` ||" }, "periodicBy": { "type": "string", "description": "| The reset period for the counter:" }, "timezone": { "type": "string", "description": "| The timezone identifier for periodic reset, for example `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Indicator of direct numbering. Default is `false` ||" } }, "required": [ "fields", "name", "template" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.delete": { "post": { "summary": "Delete crm.documentgenerator.numerator.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.numerator.delete` removes a numerator. You can only delete numerators created through [crm.documentgenerator.numerator.add](./crm-document-generator-numerator-add.md).", "operationId": "crm_documentgenerator_numerator_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.get": { "post": { "summary": "Get Information About the Numerator crm.documentgenerator.numerator.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.numerator.get` returns information about the numerator by its identifier.", "operationId": "crm_documentgenerator_numerator_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.list": { "post": { "summary": "Get the List of Numerators crm.documentgenerator.numerator.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.numerator.list` returns a list of numerators.", "operationId": "crm_documentgenerator_numerator_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Offset for pagination. More details in the article Features of List Methods ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| Offset for pagination. More details in the article Features of List Methods ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.numerator.update": { "post": { "summary": "Update the crm.documentgenerator.numerator.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.numerator.update` updates an existing numerator.", "operationId": "crm_documentgenerator_numerator_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" }, "fields": { "type": "object", "description": "| Object with fields to update in the format:" }, "name": { "type": "string", "description": "| Name of the numerator ||" }, "template": { "type": "string", "description": "| Number template, for example `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Generator settings. Description of parameters is below ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering. Description of parameters is below ||" }, "start": { "type": "integer", "description": "| Initial value of the counter. Default is `1` ||" }, "step": { "type": "integer", "description": "| Step for incrementing the counter. Default is `1` ||" }, "length": { "type": "integer", "description": "| Minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`. Default is `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Reset period for the counter:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, for example `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Indicator of direct numbering. Default is `false` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator ||" }, "fields": { "type": "object", "description": "| Object with fields to update in the format:" }, "name": { "type": "string", "description": "| Name of the numerator ||" }, "template": { "type": "string", "description": "| Number template, for example `{NUMBER}` ||" }, "settings": { "type": "object", "description": "| Generator settings. Description of parameters is below ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering. Description of parameters is below ||" }, "start": { "type": "integer", "description": "| Initial value of the counter. Default is `1` ||" }, "step": { "type": "integer", "description": "| Step for incrementing the counter. Default is `1` ||" }, "length": { "type": "integer", "description": "| Minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`. Default is `'0'` ||" }, "periodicBy": { "type": "string", "description": "| Reset period for the counter:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, for example `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Indicator of direct numbering. Default is `false` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.add": { "post": { "summary": "Add a New Template crm.documentgenerator.template.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.add` adds a new document template.", "operationId": "crm_documentgenerator_template_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Array of access permission codes, for example `[\"UA\"]`" }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity: `Y` or `N`. Default is `Y` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamp and signature: `Y` or `N`. Default is `N` ||" }, "sort": { "type": "integer", "description": "| Sort index ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": {}, "description": "| Array of access permission codes, for example `[\"UA\"]`" }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity: `Y` or `N`. Default is `Y` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamp and signature: `Y` or `N`. Default is `N` ||" }, "sort": { "type": "integer", "description": "| Sort index ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.delete": { "post": { "summary": "Delete Document Template crm.documentgenerator.template.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.delete` removes a document template.", "operationId": "crm_documentgenerator_template_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.get": { "post": { "summary": "Get Information About Document Template by Id crm.documentgenerator.template.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.get` returns information about a template by its identifier.", "operationId": "crm_documentgenerator_template_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.getfields": { "post": { "summary": "Get Document Template Fields crm.documentgenerator.template.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.getfields` returns a card of template fields: which fields are available, their current values, default values, and service indicators.", "operationId": "crm_documentgenerator_template_getfields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM entity whose data will be used to compute field values ||" }, "values": { "type": "object", "description": "| Object format:" }, "MyCompanyRequisiteRqCompanyName": { "type": "string", "description": "| Short name of the organization ||" }, "MyCompanyRequisiteRegisteredAddressText": { "type": "string", "description": "| Full address ||" }, "MyCompanyPhone": { "type": "string", "description": "| Phone ||" }, "MyCompanyEmail": { "type": "string", "description": "| E-mail ||" }, "MyCompanyWeb": { "type": "string", "description": "| Website ||" }, "MyCompanyUfLogo": { "type": "string", "description": "\\| `null` | Logo ||" }, "RequisiteRqCompanyName": { "type": "string", "description": "| Short name of the organization ||" }, "RequisiteRegisteredAddressText": { "type": "string", "description": "| Full address ||" }, "ClientPhone": { "type": "string", "description": "| Phone ||" }, "ClientEmail": { "type": "string", "description": "| Email ||" }, "ClientWeb": { "type": "string", "description": "| Website ||" }, "DocumentNumber": { "type": "string", "description": "| Number ||" }, "DocumentCreateTime": { "type": "string", "description": "| Generation date ||" }, "ProductsIndex": { "type": "string", "description": "| Current number ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Name ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Quantity ||" }, "ProductsProductMeasureName": { "type": "array", "items": {}, "description": "\\| `string` | Units of measure ||" }, "ProductsProductPriceRaw": { "type": "array", "items": {}, "description": "\\| `string` | Original price ||" }, "ProductsProductPriceRawSum": { "type": "array", "items": {}, "description": "\\| `string` | Total original price ||" }, "TotalRaw": { "type": "string", "description": "| Total original prices ||" }, "TaxesTaxTitle": { "type": "array", "items": {}, "description": "\\| `string` | Title ||" }, "TaxesTaxRate": { "type": "array", "items": {}, "description": "\\| `string` | Rate ||" }, "TaxesTaxValue": { "type": "array", "items": {}, "description": "\\| `string` | Total ||" }, "TotalSum": { "type": "string", "description": "| Total amount ||" }, "MyCompanyAssignedName": { "type": "string", "description": "| First name ||" }, "MyCompanyAssignedLastName": { "type": "string", "description": "| Last name ||" }, "MyCompanyAssignedPersonalPhone": { "type": "string", "description": "| Phone ||" }, "MyCompanyAssignedEmail": { "type": "string", "description": "| E-Mail ||" }, "DocumentTitle": { "type": "string", "description": "| Document title ||" }, "MY_COMPANY": { "type": "array", "items": {}, "description": "| My company ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM entity whose data will be used to compute field values ||" }, "values": { "type": "object", "description": "| Object format:" }, "MyCompanyRequisiteRqCompanyName": { "type": "string", "description": "| Short name of the organization ||" }, "MyCompanyRequisiteRegisteredAddressText": { "type": "string", "description": "| Full address ||" }, "MyCompanyPhone": { "type": "string", "description": "| Phone ||" }, "MyCompanyEmail": { "type": "string", "description": "| E-mail ||" }, "MyCompanyWeb": { "type": "string", "description": "| Website ||" }, "MyCompanyUfLogo": { "type": "string", "description": "\\| `null` | Logo ||" }, "RequisiteRqCompanyName": { "type": "string", "description": "| Short name of the organization ||" }, "RequisiteRegisteredAddressText": { "type": "string", "description": "| Full address ||" }, "ClientPhone": { "type": "string", "description": "| Phone ||" }, "ClientEmail": { "type": "string", "description": "| Email ||" }, "ClientWeb": { "type": "string", "description": "| Website ||" }, "DocumentNumber": { "type": "string", "description": "| Number ||" }, "DocumentCreateTime": { "type": "string", "description": "| Generation date ||" }, "ProductsIndex": { "type": "string", "description": "| Current number ||" }, "ProductsProductName": { "type": "array", "items": {}, "description": "\\| `string` | Name ||" }, "ProductsProductQuantity": { "type": "array", "items": {}, "description": "\\| `string` | Quantity ||" }, "ProductsProductMeasureName": { "type": "array", "items": {}, "description": "\\| `string` | Units of measure ||" }, "ProductsProductPriceRaw": { "type": "array", "items": {}, "description": "\\| `string` | Original price ||" }, "ProductsProductPriceRawSum": { "type": "array", "items": {}, "description": "\\| `string` | Total original price ||" }, "TotalRaw": { "type": "string", "description": "| Total original prices ||" }, "TaxesTaxTitle": { "type": "array", "items": {}, "description": "\\| `string` | Title ||" }, "TaxesTaxRate": { "type": "array", "items": {}, "description": "\\| `string` | Rate ||" }, "TaxesTaxValue": { "type": "array", "items": {}, "description": "\\| `string` | Total ||" }, "TotalSum": { "type": "string", "description": "| Total amount ||" }, "MyCompanyAssignedName": { "type": "string", "description": "| First name ||" }, "MyCompanyAssignedLastName": { "type": "string", "description": "| Last name ||" }, "MyCompanyAssignedPersonalPhone": { "type": "string", "description": "| Phone ||" }, "MyCompanyAssignedEmail": { "type": "string", "description": "| E-Mail ||" }, "DocumentTitle": { "type": "string", "description": "| Document title ||" }, "MY_COMPANY": { "type": "array", "items": {}, "description": "| My company ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.list": { "post": { "summary": "Get a List of Document Templates crm.documentgenerator.template.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.list` returns a list of document templates.", "operationId": "crm_documentgenerator_template_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| A list of fields to return for the templates." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| A list of fields to return for the templates." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.documentgenerator.template.update": { "post": { "summary": "Update Existing Document Template crm.documentgenerator.template.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.documentgenerator.template.update` updates an existing document template.", "operationId": "crm_documentgenerator_template_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Template name ||" }, "file": { "type": "string", "description": "| Template file in the format `[\"file_name.docx\", \"base64_content\"]`. Can be sent in `base64` or `multipart/form-data`. More details: How to upload files ||" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator. A list of available numerators can be obtained using the method crm.documentgenerator.numerator.list ||" }, "region": { "type": "string", "description": "| Template region, for example `de` ||" }, "entityTypeId": { "type": "array", "items": {}, "description": "| Array of CRM entity identifiers for which the template is available." }, "users": { "type": "array", "items": {}, "description": "| Array of access permission codes, for example `[\"UA\"]`." }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity: `Y` or `N` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamp and signature: `Y` or `N` ||" }, "sort": { "type": "integer", "description": "| Sort index ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| Template name ||" }, "file": { "type": "string", "description": "| Template file in the format `[\"file_name.docx\", \"base64_content\"]`. Can be sent in `base64` or `multipart/form-data`. More details: How to upload files ||" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator. A list of available numerators can be obtained using the method crm.documentgenerator.numerator.list ||" }, "region": { "type": "string", "description": "| Template region, for example `de` ||" }, "entityTypeId": { "type": "array", "items": {}, "description": "| Array of CRM entity identifiers for which the template is available." }, "users": { "type": "array", "items": {}, "description": "| Array of access permission codes, for example `[\"UA\"]`." }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity: `Y` or `N` ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamp and signature: `Y` or `N` ||" }, "sort": { "type": "integer", "description": "| Sort index ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.findbycomm": { "post": { "summary": "Get leads, contacts, and companies with matching data crm.duplicate.findbycomm", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.duplicate.findbycomm` returns the identifiers of leads, contacts, and companies that contain phone numbers or email addresses from a specified list. The search does not consider the phone extension.", "operationId": "crm_duplicate_findbycomm", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/crm-duplicate-find-by-comm.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Type of communication. Possible values:" }, "values": { "type": "string", "description": "| Array of emails or phone numbers." }, "entity_type": { "type": "string", "description": "| Type of object. Possible values:" } }, "required": [ "type", "values" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Type of communication. Possible values:" }, "values": { "type": "string", "description": "| Array of emails or phone numbers." }, "entity_type": { "type": "string", "description": "| Type of object. Possible values:" } }, "required": [ "type", "values" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.fields": { "post": { "summary": "Get a List of Fields for Duplicate Search crm.duplicate.volatileType.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.duplicate.volatileType.fields` returns a list of standard and custom fields that can be used for finding duplicates in leads, contacts, and companies.", "operationId": "crm_duplicate_volatileType_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier for the object type. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier for the object type. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.list": { "post": { "summary": "Get a List of Custom Fields Used in Duplicate Search crm.duplicate.volatileType.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.duplicate.volatileType.list` returns a list of custom fields that are already being used to search for duplicates in leads, contacts, and companies.", "operationId": "crm_duplicate_volatileType_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.register": { "post": { "summary": "Add Field to Duplicate Search crm.duplicate.volatileType.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.duplicate.volatileType.register` adds a field to the duplicate search functionality in leads, contacts, or companies.", "operationId": "crm_duplicate_volatileType_register", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier for the object type. Possible values:" }, "fieldCode": { "type": "string", "description": "| The code of the field to be added to the duplicate search. For example, `TITLE`, `RQ.DE.NAME`, `UF_CRM_1750854801`. You can get a list of available fields using the method crm.duplicate.volatileType.fields ||" } }, "required": [ "entityTypeId", "fieldCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier for the object type. Possible values:" }, "fieldCode": { "type": "string", "description": "| The code of the field to be added to the duplicate search. For example, `TITLE`, `RQ.DE.NAME`, `UF_CRM_1750854801`. You can get a list of available fields using the method crm.duplicate.volatileType.fields ||" } }, "required": [ "entityTypeId", "fieldCode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.duplicate.volatileType.unregister": { "post": { "summary": "Remove Field from Duplicate Search crm.duplicate.volatileType.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.duplicate.volatileType.unregister` removes a custom field from the duplicate search.", "operationId": "crm_duplicate_volatileType_unregister", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/volatile-type/crm-duplicate-volatile-type-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the field record to be removed. You can obtain the identifiers of records added to the duplicate search using the method crm.duplicate.volatileType.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the field record to be removed. You can obtain the identifiers of records added to the duplicate search using the method crm.duplicate.volatileType.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.entity.mergeBatch": { "post": { "summary": "Merge Duplicates crm.entity.mergeBatch", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.entity.mergeBatch` merges multiple entities into one.", "operationId": "crm_entity_mergeBatch", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/duplicates/crm-entity-merge-batch.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object containing the entities to merge (detailed description) ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type. Possible values:" }, "entityIds": { "type": "string", "description": "| Array of identifiers of the entities to be merged. At least two entities are required ||" } }, "required": [ "params", "entityTypeId", "entityIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object containing the entities to merge (detailed description) ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object type. Possible values:" }, "entityIds": { "type": "string", "description": "| Array of identifiers of the entities to be merged. At least two entities are required ||" } }, "required": [ "params", "entityTypeId", "entityIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitydirection": { "post": { "summary": "Get Activity Direction Enumeration Elements crm.enum.activitydirection", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitydirection` returns activity directions for the `DIRECTION` field of [CRM activities related to emails and calls](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitydirection", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-direction.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitynotifytype": { "post": { "summary": "Get Enumeration Items for \"Activity Notification Type\" crm.enum.activitynotifytype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitynotifytype` returns notification types for the `NOTIFY_TYPE` field of [meetings and calls](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitynotifytype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-notify-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitypriority": { "post": { "summary": "Get Enumeration Items for \"Activity Priorities\" crm.enum.activitypriority", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitypriority` returns a list of priorities for the `PRIORITY` field of [activities](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitypriority", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-priority.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitystatus": { "post": { "summary": "Get Enumeration Elements \"Status\" crm.enum.activitystatus", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitystatus` returns a list of statuses for the `STATUS` field of [deals](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitystatus", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.activitytype": { "post": { "summary": "Get Enumeration Elements \"Activity Types\" crm.enum.activitytype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitytype` returns a list of types for the `TYPE_ID` field of [activities](../../../timeline/activities/index.md).", "operationId": "crm_enum_activitytype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-activity-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.addresstype": { "post": { "summary": "Get Address Types crm.enum.addresstype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.enum.addresstype` returns a list of address types. Use the `ID` of the address type as the value for the `TYPE_ID` parameter in the methods [crm.address.*](../../requisites/addresses/index.md).", "operationId": "crm_enum_addresstype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/crm-enum-address-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.contenttype": { "post": { "summary": "Get Enumeration Elements of \"Description Type\" crm.enum.contenttype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.contenttype` returns the description types for the `DESCRIPTION_TYPE` field of [deals](../../../timeline/activities/index.md).", "operationId": "crm_enum_contenttype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/outdated/crm-enum-content-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.fields": { "post": { "summary": "Get Fields of CRM Enumeration Elements crm.enum.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.enum.fields` returns information about the fields of enumeration elements.", "operationId": "crm_enum_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/crm-enum-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.getorderownertypes": { "post": { "summary": "Get Object Types for Order Binding crm.enum.getorderownertypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.enum.getorderownertypes` returns a list of object types to which an order can be bound. Use the `id` of the object type as the value for the `ownerTypeId` parameter in the methods [crm.orderentity.*](../../universal/order-entity/crm-order-entity-add.md). Currently, an [order binding](../../universal/order-entity/crm-order-entity-add.md) can only be done to a [deal](../../deals/index.md).", "operationId": "crm_enum_getorderownertypes", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/crm-enum-get-order-owner-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.ownertype": { "post": { "summary": "Get CRM Object Types crm.enum.ownertype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.enum.ownertype` returns the identifiers of CRM object types and SPA. Use the `ID` of the object type as the value for the `entityTypeId` parameter in the methods [crm.item.*](../../universal/index.md), [crm.activity.*](../../timeline/activities/index.md). The identifiers of SPA in each Bitrix24 are unique and may differ from those provided in the example.", "operationId": "crm_enum_ownertype", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/crm-enum-owner-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.enum.settings.mode": { "post": { "summary": "Get Description of CRM Operation Modes crm.enum.settings.mode", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.enum.settings.mode` returns a list of CRM operation modes. Use this method to decode the `ID` value of the type returned by the method [crm.settings.mode.get](../../crm-settings-mode-get.md).", "operationId": "crm_enum_settings_mode", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/enum/crm-enum-settings-mode.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.add": { "post": { "summary": "Add Invoice crm.invoice.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal methods for invoices](../../universal/invoice.md). This method creates a new invoice. If you need to specify any details of the buyer/seller in the invoice (as there may be multiple for a company), use the method [crm.requisite.link.register](../../requisites/links/crm-requisite-link-register.md).", "operationId": "crm_invoice_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the invoice." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the invoice." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.delete": { "post": { "summary": "Delete invoice crm.invoice.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal methods for invoices](../../universal/invoice.md). This method deletes an invoice.", "operationId": "crm_invoice_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.fields": { "post": { "summary": "Get Invoice Fields and Associated Products crm.invoice.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the description of the fields of an [invoice](./crm-invoice-add.md), including [custom fields](./crm-invoice-user-field-add.md). No parameters are required.", "operationId": "crm_invoice_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier | Read-only ||" }, "ACCOUNT_NUMBER": { "type": "string", "description": "| Number | ||" }, "COMMENTS": { "type": "string", "description": "| Manager's comment | ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by user | Read-only ||" }, "CURRENCY": { "type": "string", "description": "| Currency identifier | Read-only ||" }, "DATE_BILL": { "type": "string", "format": "date", "description": "| Billing date | ||" }, "DATE_INSERT": { "type": "string", "format": "date-time", "description": "| Creation date | ||" }, "DATE_MARKED": { "type": "string", "format": "date-time", "description": "| Rejection date | Provided if the invoice is rejected ||" }, "DATE_PAY_BEFORE": { "type": "string", "format": "date", "description": "| Payment due date | ||" }, "DATE_PAYED": { "type": "string", "format": "date-time", "description": "| Date changed to paid status | Read-only ||" }, "DATE_STATUS": { "type": "string", "format": "date-time", "description": "| Date of status change | Read-only ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Date of update | Read-only ||" }, "EMP_PAYED_ID": { "type": "integer", "description": "| Identifier of the user who last marked the invoice as paid | Read-only ||" }, "EMP_STATUS_ID": { "type": "integer", "description": "| Identifier of the user who last changed the invoice status | Read-only ||" }, "LID": { "type": "integer", "description": "| Site identifier | Read-only ||" }, "XML_ID": { "type": "string", "description": "| External code | ||" }, "ORDER_TOPIC": { "type": "string", "description": "| Subject | ||" }, "PAY_SYSTEM_ID": { "type": "integer", "description": "| Identifier of the payment form | ||" }, "PAY_VOUCHER_DATE": { "type": "string", "format": "date", "description": "| Payment date | Provided if the invoice is paid ||" }, "PAY_VOUCHER_NUM": { "type": "string", "description": "| Payment document number | Provided if the invoice is paid ||" }, "PAYED": { "type": "string", "maxLength": 1, "description": "| Payment status | Read-only ||" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Payer type identifier | ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Amount | Read-only ||" }, "REASON_MARKED": { "type": "string", "description": "| Status comment | Provided if the invoice is paid or rejected ||" }, "RESPONSIBLE_EMAIL": { "type": "string", "description": "| Responsible person's e-mail | Read-only ||" }, "RESPONSIBLE_ID": { "type": "integer", "description": "| Identifier of the responsible person | ||" }, "RESPONSIBLE_LAST_NAME": { "type": "string", "description": "| Last name of the responsible person | Read-only ||" }, "RESPONSIBLE_LOGIN": { "type": "string", "description": "| Login of the responsible person | Read-only ||" }, "RESPONSIBLE_NAME": { "type": "string", "description": "| First name of the responsible person | Read-only ||" }, "RESPONSIBLE_PERSONAL_PHOTO": { "type": "integer", "description": "| Identifier of the responsible person's photo | Read-only ||" }, "RESPONSIBLE_SECOND_NAME": { "type": "string", "description": "| Middle name of the responsible person | Read-only ||" }, "RESPONSIBLE_WORK_POSITION": { "type": "string", "description": "| Position of the responsible person | Read-only ||" }, "STATUS_ID": { "type": "string", "description": "| Status identifier | Identifier from the \"INVOICE_STATUS\" reference ||" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount | Read-only ||" }, "UF_COMPANY_ID": { "type": "integer", "description": "| Company identifier | Provided if the payer is a \"Legal Entity\" ||" }, "UF_CONTACT_ID": { "type": "integer", "description": "| Contact identifier | Provided if the payer is an \"Individual\" or as a contact person for the company ||" }, "UF_MYCOMPANY_ID": { "type": "integer", "description": "| Identifier of your company | Provided as the company with invoice details (the link to the details is set separately) ||" }, "UF_DEAL_ID": { "type": "integer", "description": "| Identifier of the associated deal | ||" }, "USER_DESCRIPTION": { "type": "string", "description": "| Comment | ||" }, "PR_LOCATION": { "type": "integer", "description": "| Location identifier | Required if using document tax mode ||" }, "INVOICE_PROPERTIES": { "type": "array", "items": {}, "description": "| List of properties | If the client is a company, the following keys may be specified (all values are of type string):" }, "PRODUCT_ROWS": { "type": "array", "items": {}, "description": "| List of product items | Fields of the product item:" } }, "required": [ "ACCOUNT_NUMBER", "ORDER_TOPIC", "PAY_SYSTEM_ID", "PERSON_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier | Read-only ||" }, "ACCOUNT_NUMBER": { "type": "string", "description": "| Number | ||" }, "COMMENTS": { "type": "string", "description": "| Manager's comment | ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by user | Read-only ||" }, "CURRENCY": { "type": "string", "description": "| Currency identifier | Read-only ||" }, "DATE_BILL": { "type": "string", "format": "date", "description": "| Billing date | ||" }, "DATE_INSERT": { "type": "string", "format": "date-time", "description": "| Creation date | ||" }, "DATE_MARKED": { "type": "string", "format": "date-time", "description": "| Rejection date | Provided if the invoice is rejected ||" }, "DATE_PAY_BEFORE": { "type": "string", "format": "date", "description": "| Payment due date | ||" }, "DATE_PAYED": { "type": "string", "format": "date-time", "description": "| Date changed to paid status | Read-only ||" }, "DATE_STATUS": { "type": "string", "format": "date-time", "description": "| Date of status change | Read-only ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Date of update | Read-only ||" }, "EMP_PAYED_ID": { "type": "integer", "description": "| Identifier of the user who last marked the invoice as paid | Read-only ||" }, "EMP_STATUS_ID": { "type": "integer", "description": "| Identifier of the user who last changed the invoice status | Read-only ||" }, "LID": { "type": "integer", "description": "| Site identifier | Read-only ||" }, "XML_ID": { "type": "string", "description": "| External code | ||" }, "ORDER_TOPIC": { "type": "string", "description": "| Subject | ||" }, "PAY_SYSTEM_ID": { "type": "integer", "description": "| Identifier of the payment form | ||" }, "PAY_VOUCHER_DATE": { "type": "string", "format": "date", "description": "| Payment date | Provided if the invoice is paid ||" }, "PAY_VOUCHER_NUM": { "type": "string", "description": "| Payment document number | Provided if the invoice is paid ||" }, "PAYED": { "type": "string", "maxLength": 1, "description": "| Payment status | Read-only ||" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Payer type identifier | ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Amount | Read-only ||" }, "REASON_MARKED": { "type": "string", "description": "| Status comment | Provided if the invoice is paid or rejected ||" }, "RESPONSIBLE_EMAIL": { "type": "string", "description": "| Responsible person's e-mail | Read-only ||" }, "RESPONSIBLE_ID": { "type": "integer", "description": "| Identifier of the responsible person | ||" }, "RESPONSIBLE_LAST_NAME": { "type": "string", "description": "| Last name of the responsible person | Read-only ||" }, "RESPONSIBLE_LOGIN": { "type": "string", "description": "| Login of the responsible person | Read-only ||" }, "RESPONSIBLE_NAME": { "type": "string", "description": "| First name of the responsible person | Read-only ||" }, "RESPONSIBLE_PERSONAL_PHOTO": { "type": "integer", "description": "| Identifier of the responsible person's photo | Read-only ||" }, "RESPONSIBLE_SECOND_NAME": { "type": "string", "description": "| Middle name of the responsible person | Read-only ||" }, "RESPONSIBLE_WORK_POSITION": { "type": "string", "description": "| Position of the responsible person | Read-only ||" }, "STATUS_ID": { "type": "string", "description": "| Status identifier | Identifier from the \"INVOICE_STATUS\" reference ||" }, "TAX_VALUE": { "type": "number", "format": "double", "description": "| Tax amount | Read-only ||" }, "UF_COMPANY_ID": { "type": "integer", "description": "| Company identifier | Provided if the payer is a \"Legal Entity\" ||" }, "UF_CONTACT_ID": { "type": "integer", "description": "| Contact identifier | Provided if the payer is an \"Individual\" or as a contact person for the company ||" }, "UF_MYCOMPANY_ID": { "type": "integer", "description": "| Identifier of your company | Provided as the company with invoice details (the link to the details is set separately) ||" }, "UF_DEAL_ID": { "type": "integer", "description": "| Identifier of the associated deal | ||" }, "USER_DESCRIPTION": { "type": "string", "description": "| Comment | ||" }, "PR_LOCATION": { "type": "integer", "description": "| Location identifier | Required if using document tax mode ||" }, "INVOICE_PROPERTIES": { "type": "array", "items": {}, "description": "| List of properties | If the client is a company, the following keys may be specified (all values are of type string):" }, "PRODUCT_ROWS": { "type": "array", "items": {}, "description": "| List of product items | Fields of the product item:" } }, "required": [ "ACCOUNT_NUMBER", "ORDER_TOPIC", "PAY_SYSTEM_ID", "PERSON_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.get": { "post": { "summary": "Get Invoice by ID crm.invoice.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns an invoice by its ID.", "operationId": "crm_invoice_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice ID ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice ID ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.getexternallink": { "post": { "summary": "Get Link to Invoice crm.invoice.getexternallink", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a public link for an online invoice.", "operationId": "crm_invoice_getexternallink", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-get-external-link.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.list": { "post": { "summary": "Get a List of Invoices crm.invoice.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of invoices. It is an implementation of the list method for invoices. When querying, use the following masks:", "operationId": "crm_invoice_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.add": { "post": { "summary": "Add Configuration for Recurring Invoice crm.invoice.recurring.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method adds a new configuration for a recurring invoice.", "operationId": "crm_invoice_recurring_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the recurring invoice configuration. The required field is `INVOICE_ID` [ID of the invoice with the parameter `IS_RECURRING=Y`]." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the recurring invoice configuration. The required field is `INVOICE_ID` [ID of the invoice with the parameter `IS_RECURRING=Y`]." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.delete": { "post": { "summary": "Delete the Recurring Invoice Setting crm.invoice.recurring.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method deletes an existing setting for the recurring invoice template.", "operationId": "crm_invoice_recurring_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the setting ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the setting ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.expose": { "post": { "summary": "Create a New Invoice from the Template crm.invoice.recurring.expose", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method creates a new invoice from the recurring invoice template.", "operationId": "crm_invoice_recurring_expose", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-expose.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.fields": { "post": { "summary": "Get Full Template of Recurring Invoice Fields crm.invoice.recurring.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of fields for the recurring invoice template along with their descriptions. No parameters required.", "operationId": "crm_invoice_recurring_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "/ Type | Description | Note ||" }, "ID": { "type": "integer", "description": "| Identifier of the record in the recurring invoice settings table | Read-only ||" }, "INVOICE_ID": { "type": "integer", "description": "| ID of the invoice template | Immutable ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Active flag. Values: Y/N | ||" }, "NEXT_EXECUTION": { "type": "string", "format": "date", "description": "| Date of the next invoice creation from the template. Calculated by the system based on the specified parameters. If the value is empty, new invoices are not created | Read-only. ||" }, "LAST_EXECUTION": { "type": "string", "format": "date", "description": "| Date of the last invoice creation from the template | Read-only ||" }, "COUNTER_REPEAT": { "type": "integer", "description": "| Number of invoices created from the template | Read-only ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Start date for calculating the next invoice creation date | ||" }, "SEND_BILL": { "type": "string", "maxLength": 1, "description": "| Send the invoice to the email associated with the payer. Values: Y/N | ||" }, "EMAIL_ID": { "type": "integer", "description": "| ID of the field containing the payer's email | ||" }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Are there limitations on creating new invoices | ||" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Maximum number of invoices that can be created from this template | Considered if `IS_LIMIT` is equal to `T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Date until which invoices can be created from this template | Considered if `IS_LIMIT` is equal to `D` ||" }, "PARAMS": { "type": "string", "description": "Bitrix24 type: unknown" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "/ Type | Description | Note ||" }, "ID": { "type": "integer", "description": "| Identifier of the record in the recurring invoice settings table | Read-only ||" }, "INVOICE_ID": { "type": "integer", "description": "| ID of the invoice template | Immutable ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Active flag. Values: Y/N | ||" }, "NEXT_EXECUTION": { "type": "string", "format": "date", "description": "| Date of the next invoice creation from the template. Calculated by the system based on the specified parameters. If the value is empty, new invoices are not created | Read-only. ||" }, "LAST_EXECUTION": { "type": "string", "format": "date", "description": "| Date of the last invoice creation from the template | Read-only ||" }, "COUNTER_REPEAT": { "type": "integer", "description": "| Number of invoices created from the template | Read-only ||" }, "START_DATE": { "type": "string", "format": "date", "description": "| Start date for calculating the next invoice creation date | ||" }, "SEND_BILL": { "type": "string", "maxLength": 1, "description": "| Send the invoice to the email associated with the payer. Values: Y/N | ||" }, "EMAIL_ID": { "type": "integer", "description": "| ID of the field containing the payer's email | ||" }, "IS_LIMIT": { "type": "string", "maxLength": 1, "description": "| Are there limitations on creating new invoices | ||" }, "LIMIT_REPEAT": { "type": "integer", "description": "| Maximum number of invoices that can be created from this template | Considered if `IS_LIMIT` is equal to `T` ||" }, "LIMIT_DATE": { "type": "string", "format": "date", "description": "| Date until which invoices can be created from this template | Considered if `IS_LIMIT` is equal to `D` ||" }, "PARAMS": { "type": "string", "description": "Bitrix24 type: unknown" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.get": { "post": { "summary": "Get Recurring Invoice Settings by ID crm.invoice.recurring.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the fields of the recurring invoice template settings by ID.", "operationId": "crm_invoice_recurring_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template settings ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template settings ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.list": { "post": { "summary": "Get a List of Recurring Invoice Settings by Filter crm.invoice.recurring.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of recurring invoice template settings based on the specified filter. When querying, use the wildcard \"*\" to select all fields (excluding custom and multiple fields).", "operationId": "crm_invoice_recurring_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.recurring.update": { "post": { "summary": "Change Settings for Recurring Invoice crm.invoice.recurring.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing setting for the recurring invoice template.", "operationId": "crm_invoice_recurring_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-recurring-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template setting ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the setting." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the recurring invoice template setting ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the setting." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.add": { "post": { "summary": "Create a New Invoice Status crm.invoice.status.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.add` creates a new invoice status. Starting from version 19.0.0, it is recommended to use the method [crm.status.add](../../../crm/status/crm-status-add.md).", "operationId": "crm_invoice_status_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the form `array(\"field\"=>\"value\"[, ...])`, containing the values of the invoice status fields." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the form `array(\"field\"=>\"value\"[, ...])`, containing the values of the invoice status fields." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.delete": { "post": { "summary": "Delete Invoice Status crm.invoice.status.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.delete` removes the status of an invoice. Starting from version 19.0.0, it is recommended to use the method [crm.status.delete](../../../crm/status/crm-status-delete.md).", "operationId": "crm_invoice_status_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the invoice status ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the invoice status ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.fields": { "post": { "summary": "Get Invoice Status Fields crm.invoice.status.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.fields` returns the description of the invoice status fields. Starting from version 19.0.0, it is recommended to use the method [crm.status.fields](../../../crm/status/crm-status-fields.md)", "operationId": "crm_invoice_status_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_ID": { "type": "string", "description": "| Identifier of the entity associated with the invoice. Read-only ||" }, "ID": { "type": "integer", "description": "| Identifier of the invoice. Read-only ||" }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "NAME_INIT": { "type": "string", "description": "| Read-only ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "STATUS_ID": { "type": "string", "description": "| Status. Read-only ||" }, "SYSTEM": { "type": "string", "maxLength": 1, "description": "| Whether it is system or not. Read-only ||" } }, "required": [ "NAME", "SORT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_ID": { "type": "string", "description": "| Identifier of the entity associated with the invoice. Read-only ||" }, "ID": { "type": "integer", "description": "| Identifier of the invoice. Read-only ||" }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "NAME_INIT": { "type": "string", "description": "| Read-only ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "STATUS_ID": { "type": "string", "description": "| Status. Read-only ||" }, "SYSTEM": { "type": "string", "maxLength": 1, "description": "| Whether it is system or not. Read-only ||" } }, "required": [ "NAME", "SORT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.get": { "post": { "summary": "Get Invoice Status by ID crm.invoice.status.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.get` returns the status of an invoice based on its ID. Starting from version 19.0.0, it is recommended to use the method [crm.status.get](../../../crm/status/crm-status-get.md).", "operationId": "crm_invoice_status_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the invoice status ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the invoice status ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.list": { "post": { "summary": "Get a List of Invoice Statuses crm.invoice.status.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). Starting from version 19.0.0, it is recommended to use the method [crm.status.list](../../../crm/status/crm-status-list.md) The method `crm.invoice.status.list` returns a list of invoice statuses based on a filter. It is an implementation of list methods for invoice statuses.", "operationId": "crm_invoice_status_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.status.update": { "post": { "summary": "Update Invoice Status crm.invoice.status.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.update` returns the status of an invoice by its identifier. Starting from version 19.0.0, it is recommended to use the method [crm.status.update](../../../crm/status/crm-status-update.md).", "operationId": "crm_invoice_status_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice-status-old/crm-invoice-status-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the invoice status ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.invoice.status.fields." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the invoice status ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.invoice.status.fields." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.update": { "post": { "summary": "Update Invoice crm.invoice.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing invoice.", "operationId": "crm_invoice_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the invoice." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Invoice identifier ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the invoice." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.add": { "post": { "summary": "Create a Custom Field for Invoices crm.invoice.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method creates a new custom field for invoices. There is a system limitation on the field name - 20 characters. The custom field name is always prefixed with `UF_CRM_`, meaning the actual length of the name is 13 characters.", "operationId": "crm_invoice_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-user-field-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "string", "description": "| A set of fields - an array of the form `array(\"field\"=>\"value\"[, ...])`, containing the description of the custom field. A complete description of the fields can be obtained by calling the method crm.userfield.fields. ||" }, "LIST": { "type": "string", "description": "| Contains a set of list values for custom fields of type List. This is specified when creating/updating the field. Each value is an array with the following fields:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "string", "description": "| A set of fields - an array of the form `array(\"field\"=>\"value\"[, ...])`, containing the description of the custom field. A complete description of the fields can be obtained by calling the method crm.userfield.fields. ||" }, "LIST": { "type": "string", "description": "| Contains a set of list values for custom fields of type List. This is specified when creating/updating the field. Each value is an array with the following fields:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.delete": { "post": { "summary": "Delete Custom Field of Invoices crm.invoice.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method deletes a custom field of invoices.", "operationId": "crm_invoice_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-user-field-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.get": { "post": { "summary": "Get User Field by ID crm.invoice.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the user field of invoices by its ID.", "operationId": "crm_invoice_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-user-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.list": { "post": { "summary": "Get a List of Custom Fields by Filter crm.invoice.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of custom fields for invoices based on the specified filter.", "operationId": "crm_invoice_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-user-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filtering fields ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filtering fields ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.invoice.userfield.update": { "post": { "summary": "Update Custom Field crm.invoice.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing custom field for invoices.", "operationId": "crm_invoice_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-invoice-user-field-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the custom field ||" }, "fields": { "type": "string", "description": "| Set of fields - an array in the form `array(\"updatable field\"=>\"value\"[, ...])`, where \"updatable field\" can take values returned by the method crm.userfield.fields ||" }, "LIST": { "type": "string", "description": "| Contains a set of list values for custom fields of type List. This is specified when creating/updating the field. Each value is an array with the following fields:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the custom field ||" }, "fields": { "type": "string", "description": "| Set of fields - an array in the form `array(\"updatable field\"=>\"value\"[, ...])`, where \"updatable field\" can take values returned by the method crm.userfield.fields ||" }, "LIST": { "type": "string", "description": "| Contains a set of list values for custom fields of type List. This is specified when creating/updating the field. Each value is an array with the following fields:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.add": { "post": { "summary": "Create a New CRM Entity crm.item.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is a universal approach for creating objects in CRM. It allows you to create various types of objects, such as deals, contacts, companies, and others. To create an object, you need to pass the appropriate parameters, including the object type and its information: title, description, contact details, and other specifics. Upon successful execution of the request, a new object is created.", "operationId": "crm_item_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/crm-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose element we want to create." }, "fields": { "type": "object", "description": "| Object format." }, "useOriginalUfNames": { "type": "boolean", "description": "| Parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose element we want to create." }, "fields": { "type": "object", "description": "| Object format." }, "useOriginalUfNames": { "type": "boolean", "description": "| Parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.batchImport": { "post": { "summary": "Importing a Batch of CRM Records: crm.item.batchImport", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This is a universal method for importing objects into CRM. The differences from adding an object are described in more detail [`here`](./index.md). The logic for adding entities is similar to the [crm.item.import](crm-item-import.md) method. A maximum of 20 entities can be imported in a single request.", "operationId": "crm_item_batchImport", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/import/crm-item-batch-import.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type for which the entity needs to be created." }, "data": { "type": "array", "items": {}, "description": "| An array of field values for the entities. It can be viewed as an array where each element contains a set of `fields`, as described in the crm.item.import method. ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| A parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type for which the entity needs to be created." }, "data": { "type": "array", "items": {}, "description": "| An array of field values for the entities. It can be viewed as an array where each element contains a set of `fields`, as described in the crm.item.import method. ||" }, "useOriginalUfNames": { "type": "boolean", "description": "| A parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delete": { "post": { "summary": "Delete CRM Item: crm.item.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a CRM object element by its item ID and entity type ID.", "operationId": "crm_item_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/crm-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| The identifier of the system or custom type whose element we want to delete." }, "id": { "type": "integer", "description": "| The identifier of the item to be deleted." } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| The identifier of the system or custom type whose element we want to delete." }, "id": { "type": "integer", "description": "| The identifier of the item to be deleted." } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delivery.get": { "post": { "summary": "Get Delivery Information by ID crm.item.delivery.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves brief information about the delivery.", "operationId": "crm_item_delivery_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/delivery/crm-item-delivery-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Delivery identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Delivery identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.delivery.list": { "post": { "summary": "Get the list of deliveries for a CRM entity crm.item.delivery.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the list of deliveries for a specific crm entity.", "operationId": "crm_item_delivery_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/delivery/crm-item-delivery-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the crm entity ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `crm entity type` ||" }, "filter": { "type": "object", "description": "| Additional filter for cases when you need to get not all deliveries of the crm entity, but based on a more specific filter." }, "order": { "type": "object", "description": "| The format of the `order` parameter corresponds to what is described in the `sale.shipment.list` method ||" } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the crm entity ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `crm entity type` ||" }, "filter": { "type": "object", "description": "| Additional filter for cases when you need to get not all deliveries of the crm entity, but based on a more specific filter." }, "order": { "type": "object", "description": "| The format of the `order` parameter corresponds to what is described in the `sale.shipment.list` method ||" } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Set a Common Detail Form for All Users crm.item.details.configuration.forceCommonScopeForAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.item.details.configuration.forceCommonScopeForAll` enforces a common detail form for all users, removing their personal detail form settings.", "operationId": "crm_item_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type of CRM entities ||" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type of CRM entities ||" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.reset": { "post": { "summary": "Reset Item Card Parameters crm.item.details.configuration.reset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.item.details.configuration.reset` resets the item card settings to their default values. It removes the personal settings of the specified user or the shared settings defined for all users.", "operationId": "crm_item_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-reset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type of CRM objects ||" }, "userId": { "type": "string", "description": "| Identifier of the user whose configuration you want to reset." }, "scope": { "type": "string", "description": "| Scope of the settings. Acceptable values:" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type of CRM objects ||" }, "userId": { "type": "string", "description": "| Identifier of the user whose configuration you want to reset." }, "scope": { "type": "string", "description": "| Scope of the settings. Acceptable values:" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.details.configuration.set": { "post": { "summary": "Set Parameters for crm.item.details.configuration.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.item.details.configuration.set` sets the settings for the card of a specific CRM object. It records the personal settings of the specified user or common settings for all users.", "operationId": "crm_item_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/item-details-configuration/crm-item-details-configuration-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM objects ||" }, "data": { "type": "string", "description": "| List of `section` describing the configuration of field sections in the item card. The structure of `section` is described below ||" }, "userId": { "type": "string", "description": "| Identifier of the user for whom you want to set the configuration." }, "scope": { "type": "string", "description": "| Scope of the settings. Allowed values:" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section. Displayed in the item card ||" }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| Array of `section_element`, describing the configuration of fields in the section ||" }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional options list for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier of the default address type. To find out possible address types, use [`crm.enum.addresstype`][2] | `Computed` ||" }, "defaultCountry": { "type": "string", "description": "| `PHONE`" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Is the payment acceptance button displayed." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Is the \"Payment and Delivery\" block displayed." }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId", "data", "name", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or user-defined type of CRM objects ||" }, "data": { "type": "string", "description": "| List of `section` describing the configuration of field sections in the item card. The structure of `section` is described below ||" }, "userId": { "type": "string", "description": "| Identifier of the user for whom you want to set the configuration." }, "scope": { "type": "string", "description": "| Scope of the settings. Allowed values:" }, "extras": { "type": "object", "description": "| Additional parameters. Possible values and their structure are described below ||" }, "name": { "type": "string", "description": "| Unique name of the section ||" }, "title": { "type": "string", "description": "| Title of the section. Displayed in the item card ||" }, "type": { "type": "string", "description": "| Type of the section." }, "elements": { "type": "string", "description": "| Array of `section_element`, describing the configuration of fields in the section ||" }, "optionFlags": { "type": "integer", "description": "| Should the field always be displayed:" }, "options": { "type": "object", "description": "| Additional options list for the field ||" }, "defaultAddressType": { "type": "integer", "description": "| `ADDRESS` | Identifier of the default address type. To find out possible address types, use [`crm.enum.addresstype`][2] | `Computed` ||" }, "defaultCountry": { "type": "string", "description": "| `PHONE`" }, "isPayButtonVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Is the payment acceptance button displayed." }, "isPaymentDocumentsVisible": { "type": "boolean", "description": "| `OPPORTUNITY_WITH_CURRENCY` | Is the \"Payment and Delivery\" block displayed." }, "SPA": { "type": "string", "description": "| `categoryId` | Identifier of the SPA funnel. Can be obtained using `crm.category.list`." }, "Deal": { "type": "string", "description": "| `dealCategoryId` | Identifier of the deal funnel. Can be obtained using `crm.category.list`." }, "Lead": { "type": "string", "description": "| `leadCustomerType` | Type of leads." } }, "required": [ "entityTypeId", "data", "name", "title", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.get": { "post": { "summary": "Get Element by Id crm.item.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns information about an entity based on its identifier and the identifier of the CRM object type.", "operationId": "crm_item_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/crm-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose element we want to retrieve." }, "id": { "type": "integer", "description": "| Identifier of the element whose information we want to retrieve." }, "useOriginalUfNames": { "type": "boolean", "description": "| This parameter is used to control the format of custom field names in the response." } }, "required": [ "entityTypeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose element we want to retrieve." }, "id": { "type": "integer", "description": "| Identifier of the element whose information we want to retrieve." }, "useOriginalUfNames": { "type": "boolean", "description": "| This parameter is used to control the format of custom field names in the response." } }, "required": [ "entityTypeId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.import": { "post": { "summary": "Import One Record crm.item.import", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. A universal method for importing objects into CRM. You can read about the differences between the import logic and the standard addition of elements in the article [{#T}](./index.md).", "operationId": "crm_item_import", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/import/crm-item-import.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| The identifier of the system or custom type for which you need to create an element." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "useOriginalUfNames": { "type": "boolean", "description": "| A parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| The identifier of the system or custom type for which you need to create an element." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "useOriginalUfNames": { "type": "boolean", "description": "| A parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.list": { "post": { "summary": "Get a List of CRM Items: crm.item.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of items of a specific type from the CRM object. CRM object items will not be included in the final selection if the user does not have \"read\" access permission for those items.", "operationId": "crm_item_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/crm-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose items need to be retrieved." }, "select": { "type": "array", "items": {}, "description": "| List of fields that should be populated in the items of the selection." }, "filter": { "type": "object", "description": "|" }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "useOriginalUfNames": { "type": "boolean", "description": "| Parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the system or custom type whose items need to be retrieved." }, "select": { "type": "array", "items": {}, "description": "| List of fields that should be populated in the items of the selection." }, "filter": { "type": "object", "description": "|" }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "useOriginalUfNames": { "type": "boolean", "description": "| Parameter to control the format of custom field names in the request and response." } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.add": { "post": { "summary": "Add Payment crm.item.payment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a payment for a CRM object.", "operationId": "crm_item_payment_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `CRM object type` ||" } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `CRM object type` ||" } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delete": { "post": { "summary": "Delete Payment crm.item.payment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a payment.", "operationId": "crm_item_payment_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.add": { "post": { "summary": "Add Delivery Item to Payment crm.item.payment.delivery.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a delivery item to the payment.", "operationId": "crm_item_payment_delivery_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "deliveryId": { "type": "string", "description": "| Identifier of the delivery." } }, "required": [ "paymentId", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "deliveryId": { "type": "string", "description": "| Identifier of the delivery." } }, "required": [ "paymentId", "deliveryId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.delete": { "post": { "summary": "Remove Delivery Item from Payment crm.item.payment.delivery.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a delivery item from the payment.", "operationId": "crm_item_payment_delivery_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the delivery item in the payment." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the delivery item in the payment." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.list": { "post": { "summary": "Get Delivery Item List by Specific Payment crm.item.payment.delivery.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of delivery items for a specific payment.", "operationId": "crm_item_payment_delivery_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Payment identifier." }, "filter": { "type": "object", "description": "| Object for filtering selected delivery items in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected delivery items for payment in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "paymentId", "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Payment identifier." }, "filter": { "type": "object", "description": "| Object for filtering selected delivery items in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected delivery items for payment in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "paymentId", "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.delivery.setDelivery": { "post": { "summary": "Reassign Delivery Position to Another Document crm.item.payment.delivery.setDelivery", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method reassigns a delivery position to another delivery document.", "operationId": "crm_item_payment_delivery_setDelivery", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/delivery-in-payment/crm-item-payment-delivery-set-delivery.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the delivery position in the payment." }, "deliveryId": { "type": "string", "description": "| Identifier of the delivery." } }, "required": [ "id", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the delivery position in the payment." }, "deliveryId": { "type": "string", "description": "| Identifier of the delivery." } }, "required": [ "id", "deliveryId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.get": { "post": { "summary": "Get Payment Information crm.item.payment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves brief information about the payment.", "operationId": "crm_item_payment_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.list": { "post": { "summary": "Get the list of payments crm.item.payment.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of payments for a specific CRM object.", "operationId": "crm_item_payment_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `CRM object type` ||" }, "filter": { "type": "object", "description": "| Additional filter for cases when you need to get not all payments of the entity, but based on a more specific filter. The format description is provided in the filter parameter of the `sale.payment.list` method ||" }, "order": { "type": "object", "description": "| The format description is provided in the order parameter of the `sale.payment.list` method ||" } }, "required": [ "entityId", "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the `CRM object type` ||" }, "filter": { "type": "object", "description": "| Additional filter for cases when you need to get not all payments of the entity, but based on a more specific filter. The format description is provided in the filter parameter of the `sale.payment.list` method ||" }, "order": { "type": "object", "description": "| The format description is provided in the order parameter of the `sale.payment.list` method ||" } }, "required": [ "entityId", "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.pay": { "post": { "summary": "Change Payment Status to \"Paid\" crm.item.payment.pay", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the payment status to \"Paid\".", "operationId": "crm_item_payment_pay", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-pay.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.add": { "post": { "summary": "Adding a Product Item to Payment crm.item.payment.product.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a product item to the payment.", "operationId": "crm_item_payment_product_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "rowId": { "type": "integer", "description": "| Identifier of the product item in the CRM object." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" } }, "required": [ "paymentId", "rowId", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "rowId": { "type": "integer", "description": "| Identifier of the product item in the CRM object." }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" } }, "required": [ "paymentId", "rowId", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.delete": { "post": { "summary": "Remove Product Item from Payment crm.item.payment.product.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a product item from the payment.", "operationId": "crm_item_payment_product_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product item in the payment." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product item in the payment." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.list": { "post": { "summary": "Get a List of Payment Product Items crm.item.payment.product.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of product items (goods or services) associated with a specific payment.", "operationId": "crm_item_payment_product_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "filter": { "type": "object", "description": "| Object for filtering selected payment product items in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected payment product items in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "paymentId", "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "| Identifier of the payment." }, "filter": { "type": "object", "description": "| Object for filtering selected payment product items in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected payment product items in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } }, "required": [ "paymentId", "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.product.setQuantity": { "post": { "summary": "Change Product Quantity crm.item.payment.product.setQuantity", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the quantity of a product in the payment line item.", "operationId": "crm_item_payment_product_setQuantity", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/products-in-payment/crm-item-payment-product-set-quantity.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product line item in the payment ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" } }, "required": [ "id", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product line item in the payment ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" } }, "required": [ "id", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.unpay": { "post": { "summary": "Change Payment Status to \"Unpaid\" crm.item.payment.unpay", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the payment status to \"Unpaid\".", "operationId": "crm_item_payment_unpay", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-unpay.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.payment.update": { "post": { "summary": "Update Payment Fields crm.item.payment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a limited set of payment fields (see [`sale.payment.update`](../../../sale/payment/sale-payment-update.md) for extended functionality with payment fields).", "operationId": "crm_item_payment_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/crm-item-payment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the payment ||" }, "paid": { "type": "string", "description": "| Payment status." }, "paySystemId": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the payment ||" }, "paid": { "type": "string", "description": "| Payment status." }, "paySystemId": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.add": { "post": { "summary": "Add Product Row to CRM Object crm.item.productrow.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a product row to a CRM object.", "operationId": "crm_item_productrow_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing field values for adding the product row to the CRM object ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row. If not provided, but `productId` is given, the product name from the product catalog is used ||" }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product. Default is 1 ||" }, "discountTypeId": { "type": "integer", "description": "| Type of discount. Possible values:" }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether the tax is included in the price. Possible values:" }, "measureCode": { "type": "string", "description": "| Unit of measure code. If not provided and `productId` is given, the unit of measure from the product catalog is used ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "ownerId", "ownerType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing field values for adding the product row to the CRM object ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row. If not provided, but `productId` is given, the product name from the product catalog is used ||" }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product. Default is 1 ||" }, "discountTypeId": { "type": "integer", "description": "| Type of discount. Possible values:" }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether the tax is included in the price. Possible values:" }, "measureCode": { "type": "string", "description": "| Unit of measure code. If not provided and `productId` is given, the unit of measure from the product catalog is used ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "ownerId", "ownerType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.delete": { "post": { "summary": "Delete product row from CRM object crm.item.productrow.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a product row from the CRM object.", "operationId": "crm_item_productrow_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product row ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product row ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.fields": { "post": { "summary": "Get the list of fields for product rows crm.item.productrow.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the list of fields for product rows. No parameters.", "operationId": "crm_item_productrow_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "fields": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the crm_item_product_row object, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "fields": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the crm_item_product_row object, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.get": { "post": { "summary": "Get information about a product item by id crm.item.productrow.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a product item in the CRM.", "operationId": "crm_item_productrow_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product item ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product item ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.getAvailableForPayment": { "post": { "summary": "Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves product rows of the CRM object for which the client has not yet been billed.", "operationId": "crm_item_productrow_getAvailableForPayment", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-get-available-for-payment.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" } }, "required": [ "ownerId", "ownerType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" } }, "required": [ "ownerId", "ownerType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.list": { "post": { "summary": "Get product rows of the CRM object crm.item.productrow.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves product rows of the CRM object.", "operationId": "crm_item_productrow_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object for filtering selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected elements of the shipment table in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Parameter used for managing pagination." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object for filtering selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| Object for sorting selected elements of the shipment table in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| Parameter used for managing pagination." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.set": { "post": { "summary": "Save Product Row of CRM Object crm.item.productrow.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method saves the product row of a CRM object. Please note that this method will overwrite all existing product rows associated with the object. Thus, it replaces the existing product rows with those that were sent.", "operationId": "crm_item_productrow_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" }, "productRows": { "type": "string", "description": "| Array of objects containing information about the product rows to be saved in the object ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row." }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product." }, "discountTypeId": { "type": "integer", "description": "| Type of discount." }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether tax is included in the price." }, "measureCode": { "type": "string", "description": "| Unit of measure code." }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "ownerId", "ownerType", "productRows" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerId": { "type": "integer", "description": "| Identifier of the CRM object ||" }, "ownerType": { "type": "string", "description": "| Identifier of the `CRM object type`. Pass the Short symbolic code of the type ||" }, "productRows": { "type": "string", "description": "| Array of objects containing information about the product rows to be saved in the object ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row." }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product." }, "discountTypeId": { "type": "integer", "description": "| Type of discount." }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether tax is included in the price." }, "measureCode": { "type": "string", "description": "| Unit of measure code." }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "ownerId", "ownerType", "productRows" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.item.productrow.update": { "post": { "summary": "Update the product row of a CRM object crm.item.productrow.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the product row of a CRM object.", "operationId": "crm_item_productrow_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/product-rows/crm-item-productrow-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product row ||" }, "fields": { "type": "object", "description": "| Object containing field values for updating the product row of the CRM object ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row ||" }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "discountTypeId": { "type": "integer", "description": "| Type of discount." }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether tax is included in the price." }, "measureCode": { "type": "string", "description": "| Unit of measure code ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the product row ||" }, "fields": { "type": "object", "description": "| Object containing field values for updating the product row of the CRM object ||" }, "productId": { "type": "string", "description": "| Identifier of the product from the catalog ||" }, "productName": { "type": "string", "description": "| Name of the product in the product row ||" }, "price": { "type": "number", "format": "double", "description": "| Price per unit of the product row, including discounts and taxes ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "discountTypeId": { "type": "integer", "description": "| Type of discount." }, "discountRate": { "type": "number", "format": "double", "description": "| Discount value in percentage (if using the percentage discount type) ||" }, "discountSum": { "type": "number", "format": "double", "description": "| Absolute discount value (if using the absolute discount type) ||" }, "taxRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "taxIncluded": { "type": "string", "description": "| Indicator of whether tax is included in the price." }, "measureCode": { "type": "string", "description": "| Unit of measure code ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.add": { "post": { "summary": "Create a New Lead crm.lead.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.lead.add` creates a new lead.", "operationId": "crm_lead_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Optional array of options (`\"optionName\"=>\"value\"[, ...]`). The list of possible fields is described below ||" }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address. In some countries, it is customary to split the address into 2 parts ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Birthdate ||" }, "COMMENTS": { "type": "string", "description": "| Comments ||" }, "COMPANY_ID": { "type": "string", "description": "| Link the lead to a company ||" }, "COMPANY_TITLE": { "type": "string", "description": "| Company name as specified in the corresponding lead field. To link an existing company, pass its id in the COMPANY_ID field ||" }, "CONTACT_ID": { "type": "string", "description": "| Link the lead to a contact ||" }, "CONTACT_IDS": { "type": "string", "description": "| List of contacts linked to the lead." }, "CURRENCY_ID": { "type": "string", "description": "| Currency identifier ||" }, "EMAIL": { "type": "string", "description": "| Email address. Multiple ||" }, "HONORIFIC": { "type": "string", "description": "| Salutation ||" }, "IM": { "type": "string", "description": "| Messenger. Multiple ||" }, "LINK": { "type": "string", "description": "| User ID linked through Open Channels. Multiple ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Indicator of lead availability for everyone. Acceptable values are `Y` or `N`.||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicator of manual calculation mode for the amount. Acceptable values are Y or N||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the item in the data source. Used only for linking to an external source ||" }, "PHONE": { "type": "string", "description": "| Phone. Multiple ||" }, "POST": { "type": "string", "description": "| Position ||" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Description of the source ||" }, "SOURCE_ID": { "type": "string", "description": "| Identifier of the source." }, "STATUS_DESCRIPTION": { "type": "string", "description": "| Additional information about the stage ||" }, "STATUS_ID": { "type": "string", "description": "| Identifier of the lead stage. Default stages:" }, "TITLE": { "type": "string", "description": "| Lead title ||" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. CPC (ads), CPM (banners) ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system. Google Ads, Bing Ads, etc. ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "WEB": { "type": "string", "description": "| Website. Multiple ||" }, "UF_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Flag `Y`/`N` - register the lead addition event. Additionally, a notification will be sent to the responsible person for the lead ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Optional array of options (`\"optionName\"=>\"value\"[, ...]`). The list of possible fields is described below ||" }, "ADDRESS": { "type": "string", "description": "| Address ||" }, "ADDRESS_2": { "type": "string", "description": "| Second line of the address. In some countries, it is customary to split the address into 2 parts ||" }, "ADDRESS_CITY": { "type": "string", "description": "| City ||" }, "ADDRESS_COUNTRY": { "type": "string", "description": "| Country ||" }, "ADDRESS_COUNTRY_CODE": { "type": "string", "description": "| Country code ||" }, "ADDRESS_POSTAL_CODE": { "type": "string", "description": "| Postal code ||" }, "ADDRESS_PROVINCE": { "type": "string", "description": "| Province ||" }, "ADDRESS_REGION": { "type": "string", "description": "| Region ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Responsible person ||" }, "BIRTHDATE": { "type": "string", "format": "date", "description": "| Birthdate ||" }, "COMMENTS": { "type": "string", "description": "| Comments ||" }, "COMPANY_ID": { "type": "string", "description": "| Link the lead to a company ||" }, "COMPANY_TITLE": { "type": "string", "description": "| Company name as specified in the corresponding lead field. To link an existing company, pass its id in the COMPANY_ID field ||" }, "CONTACT_ID": { "type": "string", "description": "| Link the lead to a contact ||" }, "CONTACT_IDS": { "type": "string", "description": "| List of contacts linked to the lead." }, "CURRENCY_ID": { "type": "string", "description": "| Currency identifier ||" }, "EMAIL": { "type": "string", "description": "| Email address. Multiple ||" }, "HONORIFIC": { "type": "string", "description": "| Salutation ||" }, "IM": { "type": "string", "description": "| Messenger. Multiple ||" }, "LINK": { "type": "string", "description": "| User ID linked through Open Channels. Multiple ||" }, "LAST_NAME": { "type": "string", "description": "| Last name ||" }, "NAME": { "type": "string", "description": "| First name ||" }, "SECOND_NAME": { "type": "string", "description": "| Middle name ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Indicator of lead availability for everyone. Acceptable values are `Y` or `N`.||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount ||" }, "IS_MANUAL_OPPORTUNITY": { "type": "string", "maxLength": 1, "description": "| Indicator of manual calculation mode for the amount. Acceptable values are Y or N||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the data source." }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the item in the data source. Used only for linking to an external source ||" }, "PHONE": { "type": "string", "description": "| Phone. Multiple ||" }, "POST": { "type": "string", "description": "| Position ||" }, "SOURCE_DESCRIPTION": { "type": "string", "description": "| Description of the source ||" }, "SOURCE_ID": { "type": "string", "description": "| Identifier of the source." }, "STATUS_DESCRIPTION": { "type": "string", "description": "| Additional information about the stage ||" }, "STATUS_ID": { "type": "string", "description": "| Identifier of the lead stage. Default stages:" }, "TITLE": { "type": "string", "description": "| Lead title ||" }, "UTM_CAMPAIGN": { "type": "string", "description": "| Advertising campaign designation ||" }, "UTM_CONTENT": { "type": "string", "description": "| Content of the campaign. For example, for contextual ads ||" }, "UTM_MEDIUM": { "type": "string", "description": "| Type of traffic. CPC (ads), CPM (banners) ||" }, "UTM_SOURCE": { "type": "string", "description": "| Advertising system. Google Ads, Bing Ads, etc. ||" }, "UTM_TERM": { "type": "string", "description": "| Search condition of the campaign. For example, keywords for contextual advertising ||" }, "WEB": { "type": "string", "description": "| Website. Multiple ||" }, "UF_...": { "type": "string", "description": "| Custom fields. For example, `UF_CRM_25534736`." }, "REGISTER_SONET_EVENT": { "type": "boolean", "description": "| Flag `Y`/`N` - register the lead addition event. Additionally, a notification will be sent to the responsible person for the lead ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.add": { "post": { "summary": "Add Contact Binding to Lead crm.lead.contact.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a contact binding to the specified lead.", "operationId": "crm_lead_contact_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead to which the contact should be added. The lead identifier can be obtained using the get lead list method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a contact to the lead in the form of a structure:" }, "CONTACT_ID": { "type": "integer", "description": "| The identifier of the contact ||" }, "SORT": { "type": "integer", "description": "| Sort index. Defaults to `10` ||" }, "IS_PRIMARY": { "type": "string", "description": "| Primary contact flag" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead to which the contact should be added. The lead identifier can be obtained using the get lead list method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a contact to the lead in the form of a structure:" }, "CONTACT_ID": { "type": "integer", "description": "| The identifier of the contact ||" }, "SORT": { "type": "integer", "description": "| Sort index. Defaults to `10` ||" }, "IS_PRIMARY": { "type": "string", "description": "| Primary contact flag" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.delete": { "post": { "summary": "Remove contact binding from lead crm.lead.contact.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the binding of a contact to the specified lead.", "operationId": "crm_lead_contact_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the lead from which to remove the contact binding. The lead identifier can be obtained using the get lead list method. ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a contact to the lead in the form of a structure:" }, "CONTACT_ID": { "type": "integer", "description": "| Identifier of the contact ||" } }, "required": [ "id", "fields", "CONTACT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the lead from which to remove the contact binding. The lead identifier can be obtained using the get lead list method. ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a contact to the lead in the form of a structure:" }, "CONTACT_ID": { "type": "integer", "description": "| Identifier of the contact ||" } }, "required": [ "id", "fields", "CONTACT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.fields": { "post": { "summary": "Get Lead-Contact Fields crm.lead.contact.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the description of fields for the lead-contact relationship, used by methods in the `crm.lead.contact.*` family. No parameters.", "operationId": "crm_lead_contact_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing fields:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing fields:" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.delete": { "post": { "summary": "Delete Contact List from Lead crm.lead.contact.items.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the contact list from a lead.", "operationId": "crm_lead_contact_items_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-items-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Lead identifier. The lead identifier can be obtained using the get lead list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Lead identifier. The lead identifier can be obtained using the get lead list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.get": { "post": { "summary": "Get a List of Related Contacts crm.lead.contact.items.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of contacts associated with a lead.", "operationId": "crm_lead_contact_items_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-items-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead. The lead identifier can be obtained using the get lead list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead. The lead identifier can be obtained using the get lead list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.contact.items.set": { "post": { "summary": "Attach a list of contacts to a lead crm.lead.contact.items.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method attaches a list of contacts to the specified lead.", "operationId": "crm_lead_contact_items_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/management-communication/crm-lead-contact-items-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the lead. The lead identifier can be obtained using the get lead list method ||" }, "items": { "type": "object", "description": "| A set of contacts represented as an array of objects with the following fields:" } }, "required": [ "id", "items" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the lead. The lead identifier can be obtained using the get lead list method ||" }, "items": { "type": "object", "description": "| A set of contacts represented as an array of objects with the following fields:" } }, "required": [ "id", "items" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.delete": { "post": { "summary": "Delete Lead crm.lead.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.lead.delete` removes a lead and all associated objects: tasks, history, timeline records, and others. Objects are deleted if they are not linked to other objects or entities. If the objects are linked to other entities, only the link to the deleted lead will be removed.", "operationId": "crm_lead_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Lead identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Lead identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.forceCommonScopeForAll": { "post": { "summary": "Set Common Lead Card for All Users crm.lead.details.configuration.forceCommonScopeForAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.lead.details.configuration.forceCommonScopeForAll` forcibly sets a common lead card for all users, removing their personal lead card settings. Settings for repeat leads may differ from those for simple leads. To switch between lead card settings, use the `leadCustomerType` parameter.", "operationId": "crm_lead_details_configuration_forceCommonScopeForAll", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/custom-form/crm-lead-details-configuration-force-common-scope-for-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Additional parameters for selecting the lead type. The structure is described below ||" }, "leadCustomerType": { "type": "integer", "description": "| Lead type. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "extras": { "type": "object", "description": "| Additional parameters for selecting the lead type. The structure is described below ||" }, "leadCustomerType": { "type": "integer", "description": "| Lead type. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.get": { "post": { "summary": "Get Parameters of crm.lead.details.configuration.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.lead.details.configuration.get` retrieves the settings for lead cards. The settings for repeat leads may differ from those for simple leads. To switch between lead card settings, use the `lead.customer.type` parameter in `extras`.", "operationId": "crm_lead_details_configuration_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/custom-form/crm-lead-details-configuration-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| The identifier of the user for whom to retrieve personal configuration." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters. The structure is described below ||" }, "lead.customer.type": { "type": "integer", "description": "| Type of lead. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| The identifier of the user for whom to retrieve personal configuration." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters. The structure is described below ||" }, "lead.customer.type": { "type": "integer", "description": "| Type of lead. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.reset": { "post": { "summary": "Resetting the Parameters of crm.lead.details.configuration.reset", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.lead.details.configuration.reset` resets the settings of lead cards. The settings for repeat leads may differ from those for simple leads. To switch between lead card settings, use the `lead.customer.type` parameter in `extras`.", "operationId": "crm_lead_details_configuration_reset", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/custom-form/crm-lead-details-configuration-reset.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| The identifier of the user for whom the personal configuration needs to be reset." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters for selecting the type of lead. The structure is described below ||" }, "lead.customer.type": { "type": "integer", "description": "| The type of lead. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "| The identifier of the user for whom the personal configuration needs to be reset." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters for selecting the type of lead. The structure is described below ||" }, "lead.customer.type": { "type": "integer", "description": "| The type of lead. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.details.configuration.set": { "post": { "summary": "Set Parameters for crm.lead.details.configuration.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.lead.details.configuration.set` sets the settings for lead cards. The settings for repeat leads may differ from those for simple leads. To switch between lead card settings, use the `leadCustomerType` parameter.", "operationId": "crm_lead_details_configuration_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/custom-form/crm-lead-details-configuration-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "description": "| A list of sections in the card. Each section contains a set of fields that will be displayed in the lead card. ||" }, "userId": { "type": "string", "description": "| The identifier of the user for whom to save the personal configuration." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters for selecting the lead type. The structure is described below ||" }, "name": { "type": "string", "description": "| Unique name of the section. ||" }, "title": { "type": "string", "description": "| Title of the section. ||" }, "type": { "type": "string", "description": "| Type of the section. Only the value `'section'` is supported. ||" }, "elements": { "type": "string", "description": "| A list of fields displayed in the section. ||" }, "optionFlags": { "type": "integer", "description": "| Whether to always show the field:" }, "options": { "type": "object", "description": "| Additional options for the field. The set of options depends on the field type. ||" }, "leadCustomerType": { "type": "integer", "description": "| Type of lead. Possible values:" } }, "required": [ "data", "name", "title", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "description": "| A list of sections in the card. Each section contains a set of fields that will be displayed in the lead card. ||" }, "userId": { "type": "string", "description": "| The identifier of the user for whom to save the personal configuration." }, "scope": { "type": "string", "description": "| The scope of the settings. Possible values:" }, "extras": { "type": "object", "description": "| Additional parameters for selecting the lead type. The structure is described below ||" }, "name": { "type": "string", "description": "| Unique name of the section. ||" }, "title": { "type": "string", "description": "| Title of the section. ||" }, "type": { "type": "string", "description": "| Type of the section. Only the value `'section'` is supported. ||" }, "elements": { "type": "string", "description": "| A list of fields displayed in the section. ||" }, "optionFlags": { "type": "integer", "description": "| Whether to always show the field:" }, "options": { "type": "object", "description": "| Additional options for the field. The set of options depends on the field type. ||" }, "leadCustomerType": { "type": "integer", "description": "| Type of lead. Possible values:" } }, "required": [ "data", "name", "title", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.fields": { "post": { "summary": "Get CRM Lead Fields crm.lead.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.lead.fields` returns a description of lead fields, including custom fields. A table with descriptions of standard fields can be found in the article [Fields of Main CRM Entities](../main-entities-fields.md).", "operationId": "crm_lead_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.get": { "post": { "summary": "Get Lead by Id crm.lead.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.lead.get` returns a lead by its identifier.", "operationId": "crm_lead_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.list": { "post": { "summary": "Get a List of Leads crm.lead.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [crm.item.list](../universal/crm-item-list.md). The method `crm.lead.list` returns a list of leads based on a filter. It is an implementation of the list method for leads.", "operationId": "crm_lead_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see lead fields crm-lead-fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected leads in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see lead fields crm-lead-fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected leads in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.productrows.get": { "post": { "summary": "Get Lead Product Rows crm.lead.productrows.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.lead.productrows.get` returns the product rows of a lead.", "operationId": "crm_lead_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-productrows-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.productrows.set": { "post": { "summary": "Set Products in Lead crm.lead.productrows.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.lead.productrows.set` creates or updates the product rows of a lead. Existing rows that are not passed to the method will be removed from the lead. To modify only a single row, use the methods [crm.item.productrow.*](../universal/product-rows/index.md).", "operationId": "crm_lead_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-productrows-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Product rows" }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog. You can get the list of products using the method `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row. If `PRODUCT_ID` is provided, the name will be taken from the product" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts but including taxes ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Quantity of the product" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Discount type" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage (if percentage discount type is used)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value (if absolute discount type is used)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.)" }, "SORT": { "type": "integer", "description": "| Sorting" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "rows": { "type": "string", "description": "| Product rows" }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog. You can get the list of products using the method `catalog.product.list`" }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row. If `PRODUCT_ID` is provided, the name will be taken from the product" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit" }, "PRICE_EXCLUSIVE": { "type": "number", "format": "double", "description": "| Cost per unit considering discounts, excluding taxes ||" }, "PRICE_NETTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts and taxes ||" }, "PRICE_BRUTTO": { "type": "number", "format": "double", "description": "| Cost per unit excluding discounts but including taxes ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Quantity of the product" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Discount type" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage (if percentage discount type is used)" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value (if absolute discount type is used)" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Indicator of whether tax is included in the price" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.)" }, "SORT": { "type": "integer", "description": "| Sorting" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.update": { "post": { "summary": "Update Lead crm.lead.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.lead.update` updates an existing lead.", "operationId": "crm_lead_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/crm-lead-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "|An optional set of options. (`\"paramName\"=>\"value\"[, ...]`). The list of possible fields is described below ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the lead." }, "fields": { "type": "object", "description": "| An object in the following format:" }, "params": { "type": "object", "description": "|An optional set of options. (`\"paramName\"=>\"value\"[, ...]`). The list of possible fields is described below ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.add": { "post": { "summary": "Create a Custom Field for Leads crm.lead.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.lead.userfield.add` creates a new custom field for leads.", "operationId": "crm_lead_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/userfield/crm-lead-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple? Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple? Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each `USER_TYPE_ID` type has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.delete": { "post": { "summary": "Delete Custom Field for Leads crm.lead.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.lead.userfield.delete` removes a custom field for leads.", "operationId": "crm_lead_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/userfield/crm-lead-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the lead." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the lead." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.get": { "post": { "summary": "Get Custom Lead Field by ID crm.lead.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.lead.userfield.get` returns a custom lead field by its identifier.", "operationId": "crm_lead_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/userfield/crm-lead-userfield-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the lead." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the lead." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.list": { "post": { "summary": "Get a List of Custom Fields for Leads crm.lead.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.lead.userfield.list` returns a list of custom fields for leads based on a filter.", "operationId": "crm_lead_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/userfield/crm-lead-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Indicates whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Indicates whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values participate in search. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the specified language will be provided:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Indicates whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Indicates whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values participate in search. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the specified language will be provided:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.lead.userfield.update": { "post": { "summary": "Update Existing Custom Field for Leads crm.lead.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.lead.userfield.update` updates an existing custom field for leads.", "operationId": "crm_lead_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/leads/userfield/crm-lead-userfield-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object in the format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional parameters for the field. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object in the format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional parameters for the field. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.add": { "post": { "summary": "Add Measurement Unit crm.measure.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.add](../../../catalog/measure/catalog-measure-add.md). This method adds a new measurement unit.", "operationId": "crm_measure_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the form `array(\"field\"=>\"value\"[, ...])`, containing the values of the measurement unit fields." }, "CODE": { "type": "integer", "description": "| Code ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Name of the measurement unit ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Symbol ||" }, "SYMBOL_INTL": { "type": "string", "description": "| International symbol ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| International letter code ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| Default ||" } }, "required": [ "fields", "CODE", "MEASURE_TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the form `array(\"field\"=>\"value\"[, ...])`, containing the values of the measurement unit fields." }, "CODE": { "type": "integer", "description": "| Code ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Name of the measurement unit ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Symbol ||" }, "SYMBOL_INTL": { "type": "string", "description": "| International symbol ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| International letter code ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| Default ||" } }, "required": [ "fields", "CODE", "MEASURE_TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.delete": { "post": { "summary": "Delete Measurement Unit crm.measure.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.delete](../../../catalog/measure/catalog-measure-delete.md). This method deletes a measurement unit.", "operationId": "crm_measure_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.fields": { "post": { "summary": "Get Available Fields of crm.measure.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.getFields](../../../catalog/measure/catalog-measure-get-fields.md). This method returns a description of the fields for measurement units. No parameters required.", "operationId": "crm_measure_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "integer", "description": "| Unit code | Required ||" }, "ID": { "type": "integer", "description": "| Identifier | Read-only ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| Default | ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Measurement unit name | Required ||" }, "SYMBOL_INTL": { "type": "string", "description": "| International symbol | ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| International letter code | ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Symbol | ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "integer", "description": "| Unit code | Required ||" }, "ID": { "type": "integer", "description": "| Identifier | Read-only ||" }, "IS_DEFAULT": { "type": "string", "maxLength": 1, "description": "| Default | ||" }, "MEASURE_TITLE": { "type": "string", "description": "| Measurement unit name | Required ||" }, "SYMBOL_INTL": { "type": "string", "description": "| International symbol | ||" }, "SYMBOL_LETTER_INTL": { "type": "string", "description": "| International letter code | ||" }, "SYMBOL_RUS": { "type": "string", "description": "| Symbol | ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.get": { "post": { "summary": "Get Field Values of Measurement Unit crm.measure.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.get](../../../catalog/measure/catalog-measure-get.md). This method returns the values of all fields of a measurement unit by its identifier.", "operationId": "crm_measure_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "id": { "type": "string", "description": "| Identifier of the measurement unit ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.list": { "post": { "summary": "Get the List of Measurement Units crm.measure.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.list](../../../catalog/measure/catalog-measure-list.md). This method returns a list of measurement units. See the description of [list methods](../../../../settings/how-to-call-rest-api/list-methods-pecularities.md).", "operationId": "crm_measure_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.measure.update": { "post": { "summary": "Update Measurement Unit crm.measure.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.measure.update](../../../catalog/measure/catalog-measure-update.md). This method updates an existing measurement unit.", "operationId": "crm_measure_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/measure/crm-measure-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the measurement unit ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the format `array(\"field_to_update\"=>\"value\"[, ...])`, where the field to update can take values returned by the method crm.measure.fields." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the measurement unit ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the format `array(\"field_to_update\"=>\"value\"[, ...])`, where the field to update can take values returned by the method crm.measure.fields." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.multifield.fields": { "post": { "summary": "Get Description of Multiple Fields crm.multifield.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.multifield.fields` returns the description of multiple fields used to store phone numbers, email addresses, and other contact information in leads, contacts, and companies.", "operationId": "crm_multifield_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/auxiliary/multifield/crm-multifield-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.add": { "post": { "summary": "Add Order Binding to CRM Object crm.orderentity.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a binding of an order to a CRM object.", "operationId": "crm_orderentity_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/order-entity/crm-order-entity-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating the binding ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type." }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating the binding ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type." }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.deleteByFilter": { "post": { "summary": "Remove Order Binding to CRM Object crm.orderentity.deleteByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the binding of an order to a CRM object.", "operationId": "crm_orderentity_deleteByFilter", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/order-entity/crm-order-entity-delete-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for removing the binding ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type." }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for removing the binding ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type." }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM object." } }, "required": [ "fields", "orderId", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.getFields": { "post": { "summary": "Get Order Binding Fields crm.orderentity.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of available order binding fields. Each field is described as a field settings structure [crm_rest_field_description](../../data-types.md#crm_rest_field_description). No parameters.", "operationId": "crm_orderentity_getFields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/order-entity/crm-order-entity-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "orderEntity": { "type": "object", "description": "| Object with a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the object crm_orderentity, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "orderEntity": { "type": "object", "description": "| Object with a list of available fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field_N` is the identifier of the object crm_orderentity, and `value` is an object of type crm_rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.orderentity.list": { "post": { "summary": "Get a list of order bindings to CRM entities crm.orderentity.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of order bindings to CRM entities.", "operationId": "crm_orderentity_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/order-entity/crm-order-entity-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the crm_orderentity object)." }, "filter": { "type": "object", "description": "| An object for filtering selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, where `field_N` is the identifier of the crm_orderentity field." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the crm_orderentity object)." }, "filter": { "type": "object", "description": "| An object for filtering selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`, where `field_N` is the identifier of the crm_orderentity field." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.paysystem.fields": { "post": { "summary": "Get Fields for Payment Methods crm.paysystem.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a description of the fields for payment methods. No parameters required.", "operationId": "crm_paysystem_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-pay-system-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.paysystem.list": { "post": { "summary": "Get a List of Payment Methods crm.paysystem.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of payment methods applicable to estimates or invoices.", "operationId": "crm_paysystem_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-pay-system-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.persontype.fields": { "post": { "summary": "Get Fields for CRM Payer Types crm.persontype.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the description of fields for payer types. No parameters required.", "operationId": "crm_persontype_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-person-type-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.persontype.list": { "post": { "summary": "Get a List of CRM Payer Types crm.persontype.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of payer types. For payment systems used in CRM (for invoices, deals), payer types should be retrieved using the `crm.persontype.list` method. If a payment system is being created for orders, then the [`sale.persontype.list`](../../../sale/person-type/sale-person-type-list.md) method should be used.", "operationId": "crm_persontype_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/invoice/crm-person-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting fields ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.add": { "post": { "summary": "Add Product crm.product.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.product.add](../../../catalog/product/catalog-product-add.md). The method `crm.product.add` creates a new product.", "operationId": "crm_product_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the product." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the product." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.delete": { "post": { "summary": "Delete Product crm.product.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.product.delete](../../../catalog/product/catalog-product-delete.md). The method `crm.product.delete` removes a product.", "operationId": "crm_product_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.fields": { "post": { "summary": "Get Product Fields crm.product.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.product.getFieldsByFilter](../../../catalog/product/catalog-product-get-fields-by-filter.md). The method `crm.product.fields` returns the description of product fields. No parameters required.", "operationId": "crm_product_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Active ||" }, "CATALOG_ID": { "type": "integer", "description": "| Catalog identifier ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency identifier ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Product creation date ||" }, "DESCRIPTION": { "type": "string", "description": "| Description ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Description type ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed picture, field available in the old product card ||" }, "ID": { "type": "integer", "description": "| Product identifier ||" }, "MEASURE": { "type": "integer", "description": "| Unit of measure ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Modified by ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview picture, field available in the old product card ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Price ||" }, "SECTION_ID": { "type": "integer", "description": "| Section identifier ||" }, "SORT": { "type": "integer", "description": "| Sort order ||" }, "TIMESTAMP_X": { "type": "string", "format": "date-time", "description": "| Product modification date ||" }, "VAT_ID": { "type": "integer", "description": "| VAT rate identifier ||" }, "VAT_INCLUDED": { "type": "string", "maxLength": 1, "description": "| VAT included in price ||" }, "XML_ID": { "type": "string", "description": "| External code ||" } }, "required": [ "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Active ||" }, "CATALOG_ID": { "type": "integer", "description": "| Catalog identifier ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by ||" }, "CURRENCY_ID": { "type": "string", "description": "| Currency identifier ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Product creation date ||" }, "DESCRIPTION": { "type": "string", "description": "| Description ||" }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Description type ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed picture, field available in the old product card ||" }, "ID": { "type": "integer", "description": "| Product identifier ||" }, "MEASURE": { "type": "integer", "description": "| Unit of measure ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Modified by ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview picture, field available in the old product card ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Price ||" }, "SECTION_ID": { "type": "integer", "description": "| Section identifier ||" }, "SORT": { "type": "integer", "description": "| Sort order ||" }, "TIMESTAMP_X": { "type": "string", "format": "date-time", "description": "| Product modification date ||" }, "VAT_ID": { "type": "integer", "description": "| VAT rate identifier ||" }, "VAT_INCLUDED": { "type": "string", "maxLength": 1, "description": "| VAT included in price ||" }, "XML_ID": { "type": "string", "description": "| External code ||" } }, "required": [ "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.get": { "post": { "summary": "Get Product by ID crm.product.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.product.get](../../../catalog/product/catalog-product-get.md). The method `crm.product.get` returns a product by its ID.", "operationId": "crm_product_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product ID ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product ID ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.list": { "post": { "summary": "Get Product List by Filter crm.product.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.product.list](../../../catalog/product/catalog-product-list.md). The method `crm.product.list` returns a list of products based on the filter.", "operationId": "crm_product_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.add": { "post": { "summary": "Add Product Property crm.product.property.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.add](../../../catalog/product-property/catalog-product-property-add.md). The method `crm.product.property.add` creates a new product property.", "operationId": "crm_product_property_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the product property." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| Field values for creating the product property." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.delete": { "post": { "summary": "Delete Product Property crm.product.property.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.delete](../../../catalog/product-property/catalog-product-property-delete.md). The method `crm.product.property.delete` removes a product property.", "operationId": "crm_product_property_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.enumeration.fields": { "post": { "summary": "Get Fields of List-Type Property crm.product.property.enumeration.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.productPropertyEnum.*](../../../catalog/product-property-enum/index.md). The method `crm.product.property.enumeration.fields` returns the description of the fields of a list-type product property. No parameters required.", "operationId": "crm_product_property_enumeration_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-enumeration-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.fields": { "post": { "summary": "Retrieve Product Property Fields crm.product.property.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.getFields](../../../catalog/product-property/catalog-product-property-get-fields.md). The method `crm.product.property.fields` returns the description of fields for product properties. No parameters required.", "operationId": "crm_product_property_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.get": { "post": { "summary": "Get Product Property by ID crm.product.property.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.get](../../../catalog/product-property/catalog-product-property-get.md). The method `crm.product.property.get` returns the property of products by ID.", "operationId": "crm_product_property_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product property ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product property ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.list": { "post": { "summary": "Get a List of Product Properties crm.product.property.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.list](../../../catalog/product-property/catalog-product-property-list.md). The method `crm.product.property.list` returns a list of product properties.", "operationId": "crm_product_property_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "| Sorting ||" }, "filter": { "type": "string", "description": "| Filter fields ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.settings.fields": { "post": { "summary": "Retrieve Additional Settings Fields for Custom Type crm.product.property.settings.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md). The method `crm.product.property.settings.fields` returns the description of the additional settings fields for custom type product properties.", "operationId": "crm_product_property_settings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-settings-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "| Property type ||" }, "userType": { "type": "string", "description": "| Custom property type ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "| Property type ||" }, "userType": { "type": "string", "description": "| Custom property type ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.types": { "post": { "summary": "Get a List of Product Property Types crm.product.property.types", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md). The method `crm.product.property.types` returns a list of product property types. No parameters required.", "operationId": "crm_product_property_types", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.property.update": { "post": { "summary": "Update Product Property crm.product.property.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.productProperty.update](../../../catalog/product-property/catalog-product-property-update.md). The method `crm.product.property.update` updates an existing product property.", "operationId": "crm_product_property_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-property-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product property ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the product property." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product property ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values for updating the product property." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.product.update": { "post": { "summary": "Update Product crm.product.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.product.update](../../../catalog/product/catalog-product-update.md). The method `crm.product.update` updates an existing product.", "operationId": "crm_product_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/products/crm-product-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields - an array of the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.product.fields." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product identifier ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields - an array of the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.product.fields." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productrow.fields": { "post": { "summary": "Get Descriptions of Fields for Product Rows crm.productrow.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.fields](../../universal/product-rows/crm-item-productrow-fields.md). This method retrieves information about the data structure of product rows in the CRM, including field types and their purposes. No parameters are required.", "operationId": "crm_productrow_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/productrow-old/crm-productrow-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productrow.list": { "post": { "summary": "Get a List of Order Properties crm.productrow.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.list](../../universal/product-rows/crm-item-productrow-list.md). This method returns a list of product rows based on a filter. It is an implementation of the list method for product rows. The owner of the product rows is determined by the required fields `OWNER_TYPE` and `OWNER_ID`, where `OWNER_TYPE` is a one-character code indicating the type (\"D\" - deal, \"L\" - lead), and `OWNER_ID` is the identifier.", "operationId": "crm_productrow_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/productrow-old/crm-productrow-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.add": { "post": { "summary": "Add a New Product Section crm.productsection.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.section.add](../../../catalog/section/catalog-section-add.md). The method `crm.productsection.add` creates a new product section.", "operationId": "crm_productsection_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the format `array(\"field\"=>\"value\"[, ...])`, containing the values of the product section fields." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A set of fields — an array in the format `array(\"field\"=>\"value\"[, ...])`, containing the values of the product section fields." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.delete": { "post": { "summary": "Delete Product Section crm.productsection.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.section.delete](../../../catalog/section/catalog-section-delete.md). The method `crm.productsection.delete` removes a product category from the catalog.", "operationId": "crm_productsection_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product section ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product section ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.fields": { "post": { "summary": "Get Fields of the Product Section crm.productsection.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.section.getFields](../../../catalog/section/catalog-section-get-fields.md). The method `crm.productsection.fields` returns the description of the [fields of the section](./crm-product-section-add.md) for the product. No parameters required.", "operationId": "crm_productsection_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CATALOG_ID": { "type": "integer", "description": "| Catalog Identifier | Immutable ||" }, "ID": { "type": "integer", "description": "| Section Identifier | Read-only ||" }, "NAME": { "type": "string", "description": "| Section Name | Required ||" }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the linked section | ||" }, "XML_ID": { "type": "string", "description": "| Symbolic Code | ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CATALOG_ID": { "type": "integer", "description": "| Catalog Identifier | Immutable ||" }, "ID": { "type": "integer", "description": "| Section Identifier | Read-only ||" }, "NAME": { "type": "string", "description": "| Section Name | Required ||" }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the linked section | ||" }, "XML_ID": { "type": "string", "description": "| Symbolic Code | ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.get": { "post": { "summary": "Get Product Section by ID crm.productsection.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.section.get](../../../catalog/section/catalog-section-get.md). The method `crm.productsection.get` [returns the product section](./crm-product-section-add.md) by its ID.", "operationId": "crm_productsection_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product section ID ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Product section ID ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.list": { "post": { "summary": "Get a List of Sections from crm.productsection.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.section.list](../../../catalog/section/catalog-section-list.md). The method `crm.productsection.list` returns a list of product sections based on a filter. It is an implementation of the list method for product sections. It is expected that the filter will specify the `CATALOG_ID` parameter. Otherwise, sections will be selected from the default catalog.", "operationId": "crm_productsection_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected ||" }, "filter": { "type": "object", "description": "| An object for filtering the selected items ||" }, "order": { "type": "object", "description": "| An object for sorting the selected items ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected ||" }, "filter": { "type": "object", "description": "| An object for filtering the selected items ||" }, "order": { "type": "object", "description": "| An object for sorting the selected items ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.productsection.update": { "post": { "summary": "Update Product Section crm.productsection.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.section.update](../../../catalog/section/catalog-section-update.md). The method `crm.productsection.update` updates an existing product section.", "operationId": "crm_productsection_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/product-section/crm-product-section-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product section ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.productsection.fields." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the product section ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of fields — an array in the form `array(\"field_to_update\"=>\"value\"[, ...])`, where \"field_to_update\" can take values returned by the method crm.productsection.fields." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.add": { "post": { "summary": "Add Estimate crm.quote.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.quote.add` creates an estimate. If you need to explicitly specify the details of the buyer and seller in the estimate, use the method [crm.requisite.link.register](../requisites/links/crm-requisite-link-register.md).", "operationId": "crm_quote_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing the fields of the estimate in the following format:" }, "params": { "type": "object", "description": "| An object of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Subject of the estimate" }, "STATUS_ID": { "type": "string", "description": "| Stage of the estimate" }, "CURRENCY_ID": { "type": "string", "description": "| Currency of the estimate amount ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount of the estimate" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the responsible person ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the client company ||" }, "CONTACT_IDS": { "type": "string", "description": "| Array of identifiers for client contacts" }, "MYCOMPANY_ID": { "type": "string", "description": "| Identifier of \"your company\" for seller requisites ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the estimate available to everyone? Possible values:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Identifier of the payer type ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Date of issue ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Expiration date of the estimate ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Client name, up to `255` characters ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Client address, up to `255` characters ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Client email, up to `255` characters ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Client phone, up to `255` characters ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "IMPORT": { "type": "boolean", "description": "| Import mode. Possible values:" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Created by ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by ||" } }, "required": [ "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing the fields of the estimate in the following format:" }, "params": { "type": "object", "description": "| An object of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Subject of the estimate" }, "STATUS_ID": { "type": "string", "description": "| Stage of the estimate" }, "CURRENCY_ID": { "type": "string", "description": "| Currency of the estimate amount ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount of the estimate" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the responsible person ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the client company ||" }, "CONTACT_IDS": { "type": "string", "description": "| Array of identifiers for client contacts" }, "MYCOMPANY_ID": { "type": "string", "description": "| Identifier of \"your company\" for seller requisites ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the estimate available to everyone? Possible values:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Identifier of the payer type ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Date of issue ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Expiration date of the estimate ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Client name, up to `255` characters ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Client address, up to `255` characters ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Client email, up to `255` characters ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Client phone, up to `255` characters ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "IMPORT": { "type": "boolean", "description": "| Import mode. Possible values:" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Created by ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Modified by ||" } }, "required": [ "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.delete": { "post": { "summary": "Delete Estimate crm.quote.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.quote.delete` removes an estimate.", "operationId": "crm_quote_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.fields": { "post": { "summary": "Get Fields of the Estimate crm.quote.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.quote.fields` returns a description of the fields of the estimate, including custom fields.", "operationId": "crm_quote_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.get": { "post": { "summary": "Get Estimate by ID: crm.quote.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.quote.get` returns an estimate by its ID.", "operationId": "crm_quote_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The ID of the estimate." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The ID of the estimate." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.list": { "post": { "summary": "Get a List of Estimates by Filter crm.quote.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.quote.list` returns a list of estimates based on a filter. This method implements the [list method](../../../settings/how-to-call-rest-api/list-methods-pecularities.md) for estimates.", "operationId": "crm_quote_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields to return in the response." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "string", "description": "| A list of fields to return in the response." }, "filter": { "type": "object", "description": "| An object in the format:" }, "order": { "type": "object", "description": "| An object in the format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.productrows.get": { "post": { "summary": "Retrieve Product Rows of the Estimate crm.quote.productrows.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.quote.productrows.get` returns the product rows of an estimate.", "operationId": "crm_quote_productrows_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-product-rows-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.productrows.set": { "post": { "summary": "Set Product Rows for the Quote crm.quote.productrows.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.quote.productrows.set` creates or updates product rows in an estimate. To modify only a single row, use the methods [crm.item.productrow.*](../universal/product-rows/index.md).", "operationId": "crm_quote_productrows_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-product-rows-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." }, "rows": { "type": "string", "description": "| Array of product rows." }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog." }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Description of the product row ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Number of product units ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Type of discount:" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Is tax included in the price:" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code ||" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." }, "rows": { "type": "string", "description": "| Array of product rows." }, "PRODUCT_ID": { "type": "integer", "description": "| Identifier of the product in the catalog." }, "PRODUCT_NAME": { "type": "string", "description": "| Name of the product row ||" }, "PRODUCT_DESCRIPTION": { "type": "string", "description": "| Description of the product row ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Final cost of the product per unit ||" }, "QUANTITY": { "type": "number", "format": "double", "description": "| Number of product units ||" }, "DISCOUNT_TYPE_ID": { "type": "integer", "description": "| Type of discount:" }, "DISCOUNT_RATE": { "type": "number", "format": "double", "description": "| Discount value in percentage ||" }, "DISCOUNT_SUM": { "type": "number", "format": "double", "description": "| Absolute discount value ||" }, "TAX_RATE": { "type": "number", "format": "double", "description": "| Tax rate in percentage ||" }, "TAX_INCLUDED": { "type": "string", "maxLength": 1, "description": "| Is tax included in the price:" }, "MEASURE_CODE": { "type": "string", "description": "| Unit of measure code ||" }, "MEASURE_NAME": { "type": "string", "description": "| Text representation of the unit of measure ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.update": { "post": { "summary": "Update Estimate crm.quote.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.quote.update` updates an existing estimate.", "operationId": "crm_quote_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/crm-quote-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." }, "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Subject of the estimate." }, "STATUS_ID": { "type": "string", "description": "| Stage of the estimate." }, "CURRENCY_ID": { "type": "string", "description": "| Currency of the estimate amount ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount of the estimate ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the responsible person ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the client company ||" }, "CONTACT_IDS": { "type": "string", "description": "| Array of identifiers for client contacts." }, "MYCOMPANY_ID": { "type": "string", "description": "| Identifier of \"your company\" for vendor details ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the estimate available to everyone? Possible values:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Identifier of the client type ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Date of issuance ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Expiration date of the estimate ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Client name, up to `255` characters ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Client address, up to `255` characters ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Client email, up to `255` characters ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Client phone, up to `255` characters ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "PARENT_ID_...": { "type": "string", "description": "| Fields for connections with smart processes." }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should a record be created in the change history? Possible values:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the estimate." }, "fields": { "type": "object", "description": "| Object format:" }, "params": { "type": "object", "description": "| Object of additional parameters (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Subject of the estimate." }, "STATUS_ID": { "type": "string", "description": "| Stage of the estimate." }, "CURRENCY_ID": { "type": "string", "description": "| Currency of the estimate amount ||" }, "OPPORTUNITY": { "type": "number", "format": "double", "description": "| Amount of the estimate ||" }, "ASSIGNED_BY_ID": { "type": "string", "description": "| Identifier of the responsible person ||" }, "COMPANY_ID": { "type": "string", "description": "| Identifier of the client company ||" }, "CONTACT_IDS": { "type": "string", "description": "| Array of identifiers for client contacts." }, "MYCOMPANY_ID": { "type": "string", "description": "| Identifier of \"your company\" for vendor details ||" }, "OPENED": { "type": "string", "maxLength": 1, "description": "| Is the estimate available to everyone? Possible values:" }, "PERSON_TYPE_ID": { "type": "integer", "description": "| Identifier of the client type ||" }, "BEGINDATE": { "type": "string", "format": "date", "description": "| Date of issuance ||" }, "CLOSEDATE": { "type": "string", "format": "date", "description": "| Expiration date of the estimate ||" }, "CLIENT_TITLE": { "type": "string", "description": "| Client name, up to `255` characters ||" }, "CLIENT_ADDR": { "type": "string", "description": "| Client address, up to `255` characters ||" }, "CLIENT_EMAIL": { "type": "string", "description": "| Client email, up to `255` characters ||" }, "CLIENT_PHONE": { "type": "string", "description": "| Client phone, up to `255` characters ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "PARENT_ID_...": { "type": "string", "description": "| Fields for connections with smart processes." }, "REGISTER_HISTORY_EVENT": { "type": "boolean", "description": "| Should a record be created in the change history? Possible values:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.add": { "post": { "summary": "Create a Custom Field for Estimates crm.quote.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.quote.userfield.add` creates a new custom field for estimates.", "operationId": "crm_quote_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/user-field/crm-quote-user-field-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| The data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each type of `USER_TYPE_ID` has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The object format:" }, "USER_TYPE_ID": { "type": "string", "description": "| The data type of the custom field. Possible values:" }, "FIELD_NAME": { "type": "string", "description": "| Field code. Unique." }, "LABEL": { "type": "string", "description": "| Default name of the custom field." }, "XML_ID": { "type": "string", "description": "| External code ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help message ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the filter. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional field parameters. Each type of `USER_TYPE_ID` has its own set of available settings, described below ||" }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, described below" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero." }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the custom field in the list." }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values included in the search." }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value. Possible values:" } }, "required": [ "fields", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.delete": { "post": { "summary": "Delete Custom Field for Quotes crm.quote.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.quote.userfield.delete` removes a custom field from quotes.", "operationId": "crm_quote_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/user-field/crm-quote-user-field-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the quote." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the quote." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.get": { "post": { "summary": "Get Custom Field of Estimates by ID crm.quote.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.quote.userfield.get` returns a custom field of estimates by its identifier.", "operationId": "crm_quote_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/user-field/crm-quote-user-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the estimate." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field associated with the estimate." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.list": { "post": { "summary": "Get a List of Custom Fields for crm.quote.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.quote.userfield.list` returns a list of custom fields for estimates based on a filter.", "operationId": "crm_quote_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/user-field/crm-quote-user-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Indicates whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Indicates whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow editing by the user. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values are searchable. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the specified language will be provided:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort index ||" }, "MULTIPLE": { "type": "boolean", "description": "| Indicates whether the custom field is multiple." }, "MANDATORY": { "type": "boolean", "description": "| Indicates whether the custom field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Whether to show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Whether to allow editing by the user. Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Whether the field values are searchable. Possible values:" }, "LANG": { "type": "string", "description": "| Language identifier. When filtering by this parameter, a set of fields with values in the specified language will be provided:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.quote.userfield.update": { "post": { "summary": "Update Existing Custom Field for Quotes crm.quote.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.quote.userfield.update` updates an existing custom field for quotes.", "operationId": "crm_quote_userfield_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/quote/user-field/crm-quote-user-field-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object in the format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional parameters for the field. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "fields": { "type": "object", "description": "| Object in the format:" }, "MANDATORY": { "type": "boolean", "description": "| Is the field mandatory? Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Should the field be shown in the filter? Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SETTINGS": { "type": "object", "description": "| Additional parameters for the field. Each field type `USER_TYPE_ID` has its own set of available settings, which are described below." }, "LIST": { "type": "string", "description": "| List of possible values for the custom field of type `enumeration`, description below ||" }, "SORT": { "type": "integer", "description": "| Sort index. Must be greater than zero ||" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Should the custom field be shown in the list?" }, "EDIT_IN_LIST": { "type": "boolean", "description": "| Allow user editing? Possible values:" }, "IS_SEARCHABLE": { "type": "boolean", "description": "| Are the field values searchable?" }, "LIST_FILTER_LABEL": { "type": "string", "description": "\\|`lang_map` | Filter label in the list." }, "LIST_COLUMN_LABEL": { "type": "string", "description": "\\|`lang_map` | Header in the list." }, "EDIT_FORM_LABEL": { "type": "string", "description": "\\|`lang_map` | Label in the edit form." }, "ERROR_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "\\|`lang_map` | Help ||" }, "VALUE": { "type": "string", "description": "| Value of the list element." }, "DEF": { "type": "boolean", "description": "| Is the list element the default value? Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.add": { "post": { "summary": "Add Requisite crm.requisite.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new requisite.", "operationId": "crm_requisite_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/universal/crm-requisite-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the requisite ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the requisite ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.add": { "post": { "summary": "Create a new bank detail crm.requisite.bankdetail.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new bank detail.", "operationId": "crm_requisite_bankdetail_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding a bank detail ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail. Identifiers of details can be obtained using the method `crm.requisite.list` ||" }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "NAME": { "type": "string", "description": "| Name of the bank detail ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Bank name ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Bank address ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank code (for country BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| BIK ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR) ||" }, "RQ_MFO": { "type": "string", "description": "| MFO ||" }, "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 (for country BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR) ||" }, "RQ_IIK": { "type": "string", "description": "| IIK ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account currency ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent account ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer ||" } }, "required": [ "fields", "ENTITY_ID", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding a bank detail ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail. Identifiers of details can be obtained using the method `crm.requisite.list` ||" }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "NAME": { "type": "string", "description": "| Name of the bank detail ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Bank name ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Bank address ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank code (for country BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| BIK ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR) ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR) ||" }, "RQ_MFO": { "type": "string", "description": "| MFO ||" }, "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 (for country BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR) ||" }, "RQ_IIK": { "type": "string", "description": "| IIK ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account currency ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent account ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer ||" } }, "required": [ "fields", "ENTITY_ID", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.delete": { "post": { "summary": "Delete bank detail crm.requisite.bankdetail.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a bank detail.", "operationId": "crm_requisite_bankdetail_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the bank detail. Bank detail identifiers can be obtained using the method `crm.requisite.bankdetail.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the bank detail. Bank detail identifiers can be obtained using the method `crm.requisite.bankdetail.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.fields": { "post": { "summary": "Get Description of Bank Details Fields crm.requisite.bankdetail.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a formal description of the bank details fields. No parameters.", "operationId": "crm_requisite_bankdetail_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the bank detail. Created automatically and unique within the account ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the detail ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the detail ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| BIK ||" }, "RQ_CODEB": { "type": "string", "description": "| Bank Code (for country FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Branch Code (for country FR) ||" }, "RQ_RIB": { "type": "string", "description": "| RIB Key (for country FR) ||" }, "RQ_MFO": { "type": "string", "description": "| MFO ||" }, "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": "| Account Type (for country BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agency (for country BR) ||" }, "RQ_IIK": { "type": "string", "description": "| IIK ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| Required attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| Read-only attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| Immutable attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| Multi-field attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| Custom attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the bank detail. Created automatically and unique within the account ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the detail ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the detail ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR) ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number ||" }, "RQ_BIK": { "type": "string", "description": "| BIK ||" }, "RQ_CODEB": { "type": "string", "description": "| Bank Code (for country FR) ||" }, "RQ_CODEG": { "type": "string", "description": "| Branch Code (for country FR) ||" }, "RQ_RIB": { "type": "string", "description": "| RIB Key (for country FR) ||" }, "RQ_MFO": { "type": "string", "description": "| MFO ||" }, "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": "| Account Type (for country BR) ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agency (for country BR) ||" }, "RQ_IIK": { "type": "string", "description": "| IIK ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT ||" }, "RQ_BIC": { "type": "string", "description": "| BIC ||" }, "COMMENTS": { "type": "string", "description": "| Comment ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| Required attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| Read-only attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| Immutable attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| Multi-field attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| Custom attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.get": { "post": { "summary": "Get bank details by id crm.requisite.bankdetail.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns bank details by identifier.", "operationId": "crm_requisite_bankdetail_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the bank details." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the bank details." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.list": { "post": { "summary": "Get a list of bank details by filter crm.requisite.bankdetail.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of bank details based on the filter.", "operationId": "crm_requisite_bankdetail_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select (see bank detail fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected bank details in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bank details in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used for managing pagination." }, "ID": { "type": "integer", "description": "| Identifier of the bank detail. Automatically created and unique within the account. ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date. ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the detail. ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the detail. ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity indicator. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting. ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank. ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank. ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR). ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number. ||" }, "RQ_BIK": { "type": "string", "description": "| BIK. ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR). ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR). ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR). ||" }, "RQ_MFO": { "type": "string", "description": "| MFO. ||" }, "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 (for country BR). ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR). ||" }, "RQ_IIK": { "type": "string", "description": "| IIK. ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency. ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account Number. ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN. ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT. ||" }, "RQ_BIC": { "type": "string", "description": "| BIC. ||" }, "COMMENTS": { "type": "string", "description": "| Comment. ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select (see bank detail fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected bank details in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bank details in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used for managing pagination." }, "ID": { "type": "integer", "description": "| Identifier of the bank detail. Automatically created and unique within the account. ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the parent object. Currently, it can only be the identifier of the detail." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values)." }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date. ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the detail. ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the detail. ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity indicator. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting. ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank. ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank. ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR). ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number. ||" }, "RQ_BIK": { "type": "string", "description": "| BIK. ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR). ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR). ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR). ||" }, "RQ_MFO": { "type": "string", "description": "| MFO. ||" }, "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 (for country BR). ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR). ||" }, "RQ_IIK": { "type": "string", "description": "| IIK. ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency. ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account Number. ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN. ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT. ||" }, "RQ_BIC": { "type": "string", "description": "| BIC. ||" }, "COMMENTS": { "type": "string", "description": "| Comment. ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.bankdetail.update": { "post": { "summary": "Update Bank Details crm.requisite.bankdetail.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing bank detail.", "operationId": "crm_requisite_bankdetail_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "integer", "description": "| Identifier of the bank detail." }, "fields": { "type": "object", "description": "| Set of bank detail fields — an object of the form `{\"field\": \"value\"[, ...]}`, the values of which need to be changed. ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting. ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank. ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank. ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR). ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number. ||" }, "RQ_BIK": { "type": "string", "description": "| BIK. ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR). ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR). ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR). ||" }, "RQ_MFO": { "type": "string", "description": "| MFO. ||" }, "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 (for country BR). ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR). ||" }, "RQ_IIK": { "type": "string", "description": "| IIK. ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency. ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account Number. ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN. ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT. ||" }, "RQ_BIC": { "type": "string", "description": "| BIC. ||" }, "COMMENTS": { "type": "string", "description": "| Comment. ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer. ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "| Description ||" }, "id": { "type": "integer", "description": "| Identifier of the bank detail." }, "fields": { "type": "object", "description": "| Set of bank detail fields — an object of the form `{\"field\": \"value\"[, ...]}`, the values of which need to be changed. ||" }, "NAME": { "type": "string", "description": "| Name of the bank detail. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the detail. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used." }, "SORT": { "type": "integer", "description": "| Sorting. ||" }, "RQ_BANK_NAME": { "type": "string", "description": "| Name of the bank. ||" }, "RQ_BANK_ADDR": { "type": "string", "description": "| Address of the bank. ||" }, "RQ_BANK_CODE": { "type": "string", "description": "| Bank Code (for country BR). ||" }, "RQ_BANK_ROUTE_NUM": { "type": "string", "description": "| Bank Routing Number. ||" }, "RQ_BIK": { "type": "string", "description": "| BIK. ||" }, "RQ_CODEB": { "type": "string", "description": "| Code Banque (for country FR). ||" }, "RQ_CODEG": { "type": "string", "description": "| Code Guichet (for country FR). ||" }, "RQ_RIB": { "type": "string", "description": "| Clé RIB (for country FR). ||" }, "RQ_MFO": { "type": "string", "description": "| MFO. ||" }, "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 (for country BR). ||" }, "RQ_AGENCY_NAME": { "type": "string", "description": "| Agência (for country BR). ||" }, "RQ_IIK": { "type": "string", "description": "| IIK. ||" }, "RQ_ACC_CURRENCY": { "type": "string", "description": "| Account Currency. ||" }, "RQ_COR_ACC_NUM": { "type": "string", "description": "| Correspondent Account Number. ||" }, "RQ_IBAN": { "type": "string", "description": "| IBAN. ||" }, "RQ_SWIFT": { "type": "string", "description": "| SWIFT. ||" }, "RQ_BIC": { "type": "string", "description": "| BIC. ||" }, "COMMENTS": { "type": "string", "description": "| Comment. ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the external information base. The purpose of the field may change by the final developer. ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.delete": { "post": { "summary": "Delete Requisite and Related Objects crm.requisite.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a requisite and all associated objects (links to other entities, addresses, bank details).", "operationId": "crm_requisite_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/universal/crm-requisite-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.get": { "post": { "summary": "Get Requisite by ID crm.requisite.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the requisite by its identifier `id`.", "operationId": "crm_requisite_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/universal/crm-requisite-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.get": { "post": { "summary": "Get the link of the requisite with the object crm.requisite.link.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the link of the requisites with the object.", "operationId": "crm_requisite_link_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/links/crm-requisite-link-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "|" }, "entityId": { "type": "integer", "description": "| Identifier of the object to which the link belongs." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "|" }, "entityId": { "type": "integer", "description": "| Identifier of the object to which the link belongs." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.list": { "post": { "summary": "Get a list of links for requisites crm.requisite.link.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of links for requisites based on the filter.", "operationId": "crm_requisite_link_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/links/crm-requisite-link-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see requisite link fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected requisite links in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected requisite links in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the object to which the link belongs." }, "REQUISITE_ID": { "type": "integer", "description": "| Identifier of the client's requisite selected for the object." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of the client's bank requisite selected for the object." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Identifier of my company's requisite selected for the object." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of my company's bank requisite selected for the object." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see requisite link fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected requisite links in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected requisite links in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the object to which the link belongs." }, "REQUISITE_ID": { "type": "integer", "description": "| Identifier of the client's requisite selected for the object." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of the client's bank requisite selected for the object." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Identifier of my company's requisite selected for the object." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of my company's bank requisite selected for the object." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.register": { "post": { "summary": "Register Requisite Link with Object crm.requisite.link.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method registers a link between requisites and an object. For successful registration, the requisite IDs must belong to the client and seller selected in the linked object. If a requisite is not available, its ID is passed as `0`. You can even specify all requisite IDs as zero. In this case, it is considered that the requisites are not linked to the object.", "operationId": "crm_requisite_link_register", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/links/crm-requisite-link-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields for the requisite link — an object of the form `{\"field\": \"value\"[, ...]}` ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the object to which the link belongs." }, "REQUISITE_ID": { "type": "integer", "description": "| Identifier of the client's requisite selected for the object." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of the client's bank requisite selected for the object." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Identifier of my company's requisite selected for the object." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of my company's bank requisite selected for the object." } }, "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": "| A set of fields for the requisite link — an object of the form `{\"field\": \"value\"[, ...]}` ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "ENTITY_ID": { "type": "integer", "description": "| Identifier of the object to which the link belongs." }, "REQUISITE_ID": { "type": "integer", "description": "| Identifier of the client's requisite selected for the object." }, "BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of the client's bank requisite selected for the object." }, "MC_REQUISITE_ID": { "type": "integer", "description": "| Identifier of my company's requisite selected for the object." }, "MC_BANK_DETAIL_ID": { "type": "integer", "description": "| Identifier of my company's bank requisite selected for the object." } }, "required": [ "fields", "ENTITY_TYPE_ID", "ENTITY_ID", "REQUISITE_ID", "BANK_DETAIL_ID", "MC_REQUISITE_ID", "MC_BANK_DETAIL_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.link.unregister": { "post": { "summary": "Unlink Requisite from Object crm.requisite.link.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the link between requisites and the object.", "operationId": "crm_requisite_link_unregister", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/links/crm-requisite-link-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "entityId": { "type": "integer", "description": "| Identifier of the object to which the link belongs." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the object type to which the link belongs." }, "entityId": { "type": "integer", "description": "| Identifier of the object to which the link belongs." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.list": { "post": { "summary": "Get a List of Requisites by Filter crm.requisite.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of requisites based on a filter.", "operationId": "crm_requisite_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/universal/crm-requisite-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see requisite fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected requisites in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see requisite fields)." }, "filter": { "type": "object", "description": "| An object for filtering the selected requisites in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.add": { "post": { "summary": "Create a Template crm.requisite.preset.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new requisites template.", "operationId": "crm_requisite_preset_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the template ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type. Currently, this is only \"Requisite\" (identifier `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of fields in the requisites template (for available values, see the method crm.requisite.preset.countries) ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "ENTITY_TYPE_ID", "COUNTRY_ID", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the template ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type. Currently, this is only \"Requisite\" (identifier `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of fields in the requisites template (for available values, see the method crm.requisite.preset.countries) ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Values `Y` or `N` are used. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "ENTITY_TYPE_ID", "COUNTRY_ID", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.countries": { "post": { "summary": "Get a list of countries for the template crm.requisite.preset.countries", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a possible list of countries for [requisite templates](./index.md). Country identifiers are used as values for the `COUNTRY_ID` field of the template. No parameters required.", "operationId": "crm_requisite_preset_countries", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-countries.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| An array of objects describing countries ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier ||" }, "CODE": { "type": "string", "description": "| Character code according to the ISO 3166-1 standard ||" }, "TITLE": { "type": "string", "description": "| Name ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": {}, "description": "| An array of objects describing countries ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier ||" }, "CODE": { "type": "string", "description": "| Character code according to the ISO 3166-1 standard ||" }, "TITLE": { "type": "string", "description": "| Name ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.delete": { "post": { "summary": "Delete the CRM Requisite Template crm.requisite.preset.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a requisite template by its identifier.", "operationId": "crm_requisite_preset_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template. It can be obtained using the method `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template. It can be obtained using the method `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.add": { "post": { "summary": "Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a custom field to the requisite template. You can use the method [crm.requisite.preset.field.availabletoadd](./crm-requisite-preset-field-available-to-add.md) to retrieve the fields available for addition to the template. Before adding a user-defined field `UF_...` to the template, it must be created using the method [crm.requisite.userfield.add](../../user-fields/crm-requisite-userfield-add.md) or ensure that it already exists.", "operationId": "crm_requisite_preset_field_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier of the template to which the custom field is added (e.g., `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the custom field to the template ||" }, "FIELD_NAME": { "type": "string", "description": "| The name of the field. ||" }, "FIELD_TITLE": { "type": "string", "description": "| An alternative name for the field in the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. The order in the list of template fields ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N` ||" } }, "required": [ "preset", "fields", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier of the template to which the custom field is added (e.g., `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding the custom field to the template ||" }, "FIELD_NAME": { "type": "string", "description": "| The name of the field. ||" }, "FIELD_TITLE": { "type": "string", "description": "| An alternative name for the field in the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. The order in the list of template fields ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N` ||" } }, "required": [ "preset", "fields", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.availabletoadd": { "post": { "summary": "Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns fields available for addition to the specified requisite template.", "operationId": "crm_requisite_preset_field_availabletoadd", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier of the template for which to retrieve the list of available customizable fields." } }, "required": [ "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier of the template for which to retrieve the list of available customizable fields." } }, "required": [ "preset" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.delete": { "post": { "summary": "Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a custom field from the requisite template.", "operationId": "crm_requisite_preset_field_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field to be deleted." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template from which the custom field is being deleted (for example, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field to be deleted." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template from which the custom field is being deleted (for example, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.fields": { "post": { "summary": "Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a formal description of the fields that describe the customizable field of the requisite template. No parameters.", "operationId": "crm_requisite_preset_field_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier, and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Field identifier. Created automatically and unique within the template ||" }, "FIELD_NAME": { "type": "string", "description": "| Field name ||" }, "FIELD_TITLE": { "type": "string", "description": "| Alternative field name for the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. Order in the list of template fields ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N` ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| \"Required\" attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| \"Read-only\" attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| \"Immutable\" attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| \"Multiple\" attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| \"Custom\" attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier, and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Field identifier. Created automatically and unique within the template ||" }, "FIELD_NAME": { "type": "string", "description": "| Field name ||" }, "FIELD_TITLE": { "type": "string", "description": "| Alternative field name for the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. Order in the list of template fields ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N` ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| \"Required\" attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| \"Read-only\" attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| \"Immutable\" attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| \"Multiple\" attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| \"Custom\" attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.get": { "post": { "summary": "Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the description of the custom field of the requisite template by its identifier.", "operationId": "crm_requisite_preset_field_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template from which the information about the custom field is extracted (for example, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template from which the information about the custom field is extracted (for example, `{\"ID\": 27}`)." } }, "required": [ "id", "preset" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.list": { "post": { "summary": "Get a list of all customizable fields for a specified CRM requisites template crm.requisite.preset.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of all customizable fields for a specific requisites template.", "operationId": "crm_requisite_preset_field_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier value of the template from which the list of customizable fields is extracted (for example, `{\"ID\": 27}`). Template identifiers can be obtained using the crm.requisite.preset.list method ||" } }, "required": [ "preset" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "preset": { "type": "object", "description": "| An object containing the identifier value of the template from which the list of customizable fields is extracted (for example, `{\"ID\": 27}`). Template identifiers can be obtained using the crm.requisite.preset.list method ||" } }, "required": [ "preset" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.field.update": { "post": { "summary": "Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a custom field in the requisite template.", "operationId": "crm_requisite_preset_field_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field to be updated." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template to which the custom field is added (e.g., `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| An object with fields and their values that need to be updated. The crm.requisite.preset.field.fields method allows you to get the description of the fields that can be modified." }, "FIELD_NAME": { "type": "string", "description": "| Name of the field." }, "FIELD_TITLE": { "type": "string", "description": "| Alternative name of the field for the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. Order in the list of template fields. ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N`. ||" } }, "required": [ "id", "preset", "fields", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom field to be updated." }, "preset": { "type": "object", "description": "| An object containing the identifier of the template to which the custom field is added (e.g., `{\"ID\": 27}`)." }, "fields": { "type": "object", "description": "| An object with fields and their values that need to be updated. The crm.requisite.preset.field.fields method allows you to get the description of the fields that can be modified." }, "FIELD_NAME": { "type": "string", "description": "| Name of the field." }, "FIELD_TITLE": { "type": "string", "description": "| Alternative name of the field for the requisite." }, "SORT": { "type": "integer", "description": "| Sorting. Order in the list of template fields. ||" }, "IN_SHORT_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N`. ||" } }, "required": [ "id", "preset", "fields", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.fields": { "post": { "summary": "Get Description of the Fields of the Requisite Template crm.requisite.preset.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a formal description of the fields of the requisite template. No parameters.", "operationId": "crm_requisite_preset_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the requisite. Created automatically and unique within the account ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type. Currently, this is only \"Requisite\" (identifier `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of fields of the requisite template (to get available values, see the method crm.requisite.preset.countries) ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. Contains an empty string if the template has not been changed since creation ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the requisite ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the requisite ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| Required attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| Read-only attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| Immutable attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| Multi-field attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| Custom attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the field identifier and `value` is the object with field attributes ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the requisite. Created automatically and unique within the account ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type. Currently, this is only \"Requisite\" (identifier `8`)." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of fields of the requisite template (to get available values, see the method crm.requisite.preset.countries) ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. Contains an empty string if the template has not been changed since creation ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the requisite ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the requisite ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "type": { "type": "string", "description": "| Field type ||" }, "isRequired": { "type": "boolean", "description": "| Required attribute. Possible values:" }, "isReadOnly": { "type": "boolean", "description": "| Read-only attribute. Possible values:" }, "isImmutable": { "type": "boolean", "description": "| Immutable attribute. Possible values:" }, "isMultiple": { "type": "boolean", "description": "| Multi-field attribute. Possible values:" }, "isDynamic": { "type": "boolean", "description": "| Custom attribute. Possible values:" }, "title": { "type": "string", "description": "| Field identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.get": { "post": { "summary": "Get Requisite Template Fields by ID crm.requisite.preset.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the requisite template by its identifier.", "operationId": "crm_requisite_preset_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template. Can be obtained using the method `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template. Can be obtained using the method `crm.requisite.preset.list` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.list": { "post": { "summary": "Get a list of requisites templates by filter crm.requisite.preset.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of requisites templates based on the filter.", "operationId": "crm_requisite_preset_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see template fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected templates in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected templates in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "ID": { "type": "integer", "description": "| Identifier of the requisite. Automatically created and unique within the account. ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of requisites template fields (to get available values, see the method crm.requisite.preset.countries). ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date. ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. Contains an empty string if the template has not been modified since creation. ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the requisite. ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the requisite. ||" }, "NAME": { "type": "string", "description": "| Name of the requisite. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites. ||" }, "SORT": { "type": "integer", "description": "| Sorting. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see template fields)." }, "filter": { "type": "object", "description": "| An object for filtering selected templates in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected templates in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "ID": { "type": "integer", "description": "| Identifier of the requisite. Automatically created and unique within the account. ||" }, "ENTITY_TYPE_ID": { "type": "integer", "description": "| Identifier of the parent object's type." }, "COUNTRY_ID": { "type": "integer", "description": "| Identifier of the country corresponding to the set of requisites template fields (to get available values, see the method crm.requisite.preset.countries). ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Creation date. ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Modification date. Contains an empty string if the template has not been modified since creation. ||" }, "CREATED_BY_ID": { "type": "string", "description": "| Identifier of the user who created the requisite. ||" }, "MODIFY_BY_ID": { "type": "string", "description": "| Identifier of the user who modified the requisite. ||" }, "NAME": { "type": "string", "description": "| Name of the requisite. ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites. ||" }, "SORT": { "type": "integer", "description": "| Sorting. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.preset.update": { "post": { "summary": "Update Requisite Template crm.requisite.preset.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the requisite template.", "operationId": "crm_requisite_preset_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/presets/crm-requisite-preset-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template to be updated. Can be obtained using the method `crm.requisite.preset.list` ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of template fields — an object of the form `{\"field\": \"value\"[, ...]}`, the values of which need to be changed ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id", "fields", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite template to be updated. Can be obtained using the method `crm.requisite.preset.list` ||" }, "fields": { "type": "array", "items": {}, "description": "| Set of template fields — an object of the form `{\"field\": \"value\"[, ...]}`, the values of which need to be changed ||" }, "NAME": { "type": "string", "description": "| Name of the requisite ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the external information base object." }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Activity status. Uses values `Y` or `N`. Determines the availability of the template in the selection list when adding requisites ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "id", "fields", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.update": { "post": { "summary": "Update Requisite crm.requisite.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing requisite.", "operationId": "crm_requisite_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/universal/crm-requisite-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite, can be obtained using the method crm.requisite.list ||" }, "fields": { "type": "object", "description": "| Set of requisite fields — an object of the form `\"field\": \"value\"[, ...]}`, the values of which need to be changed ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the requisite, can be obtained using the method crm.requisite.list ||" }, "fields": { "type": "object", "description": "| Set of requisite fields — an object of the form `\"field\": \"value\"[, ...]}`, the values of which need to be changed ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.add": { "post": { "summary": "Create a New Custom Field for crm.requisite.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new custom field for the requisite. The system limitation for the field name is 20 characters. The custom field name always has the prefix `UF_CRM_`, meaning the actual length of the name is 13 characters.", "operationId": "crm_requisite_userfield_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding a custom requisite field ||" }, "ENTITY_ID": { "type": "string", "description": "| The identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE` ||" }, "FIELD_NAME": { "type": "string", "description": "| Symbolic code. For requisites, it always starts with the prefix `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type (`string`, `boolean`, `double`, or `datetime`) ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Multiplicity indicator. Possible values:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Mandatory indicator. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Are field values included in the search. Possible values:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Header in the list ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter label in the list ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help ||" }, "LIST": { "type": "string", "description": "| List elements. For detailed information, see the section {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings (dependent on type). For detailed information, see the section {#T} ||" } }, "required": [ "fields", "ENTITY_ID", "FIELD_NAME", "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| A set of fields — an object of the form `{\"field\": \"value\"[, ...]}` for adding a custom requisite field ||" }, "ENTITY_ID": { "type": "string", "description": "| The identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE` ||" }, "FIELD_NAME": { "type": "string", "description": "| Symbolic code. For requisites, it always starts with the prefix `UF_CRM_` ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type (`string`, `boolean`, `double`, or `datetime`) ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Multiplicity indicator. Possible values:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Mandatory indicator. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Are field values included in the search. Possible values:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Header in the list ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter label in the list ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help ||" }, "LIST": { "type": "string", "description": "| List elements. For detailed information, see the section {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings (dependent on type). For detailed information, see the section {#T} ||" } }, "required": [ "fields", "ENTITY_ID", "FIELD_NAME", "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.delete": { "post": { "summary": "Delete User Field of Requisite crm.requisite.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a user field of the requisite.", "operationId": "crm_requisite_userfield_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.get": { "post": { "summary": "Get User Field by ID crm.requisite.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the user field of the requisite by its identifier.", "operationId": "crm_requisite_userfield_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.requisite.userfield.list": { "post": { "summary": "Get a list of custom fields of the requisite by filter crm.requisite.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of custom fields of the requisite based on the filter.", "operationId": "crm_requisite_userfield_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object for sorting the selected custom fields in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "object", "description": "| Object for filtering the selected requisites in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. This method's filter only supports simple value comparisons." }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE` ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Multiplicity indicator. Possible values:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Mandatory indicator. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Are field values included in search. Possible values:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Header in the list ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter label in the list ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help ||" }, "LIST": { "type": "string", "description": "| List elements. For detailed information, see the section {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings (depend on type). For detailed information, see the section {#T} ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object for sorting the selected custom fields in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "object", "description": "| Object for filtering the selected requisites in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. This method's filter only supports simple value comparisons." }, "ID": { "type": "integer", "description": "| Identifier of the custom field ||" }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE` ||" }, "XML_ID": { "type": "string", "description": "| External key. Used for exchange operations. Identifier of the object in the external information base." }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "MULTIPLE": { "type": "string", "maxLength": 1, "description": "| Multiplicity indicator. Possible values:" }, "MANDATORY": { "type": "string", "maxLength": 1, "description": "| Mandatory indicator. Possible values:" }, "SHOW_FILTER": { "type": "string", "maxLength": 1, "description": "| Show in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Show in the list. Possible values:" }, "EDIT_IN_LIST": { "type": "string", "maxLength": 1, "description": "| Allow user editing. Possible values:" }, "IS_SEARCHABLE": { "type": "string", "maxLength": 1, "description": "| Are field values included in search. Possible values:" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Header in the list ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter label in the list ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help ||" }, "LIST": { "type": "string", "description": "| List elements. For detailed information, see the section {#T} ||" }, "SETTINGS": { "type": "object", "description": "| Additional settings (depend on type). For detailed information, see the section {#T} ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.settings.mode.get": { "post": { "summary": "Determine the Current CRM Operating Mode crm.settings.mode.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the current settings of the CRM operating mode: **classic CRM mode** (with leads) or **simple CRM mode** (without leads). This mode affects a number of CRM operation scenarios, and for better understanding, we recommend reading the [relevant article](https://helpdesk.bitrix24.com/open/17611420/) in the user documentation.", "operationId": "crm_settings_mode_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/crm-settings-mode-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.stagehistory.list": { "post": { "summary": "Get Stage History with crm.stagehistory.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.stagehistory.list` returns records of stage movement history for the following elements: - [leads](./leads/index.md), - [deals](./deals/index.md),", "operationId": "crm_stagehistory_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/crm-stage-history-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the object type. Can take the following values:" }, "order": { "type": "object", "description": "| Sorting list, where the key is the field and the value is `ASC` or `DESC` ||" }, "filter": { "type": "object", "description": "| Filtering list. The filter supports the use of exact values, arrays of values, and modifiers:" }, "select": { "type": "object", "description": "| List of fields to retrieve ||" }, "start": { "type": "integer", "description": "| Offset for pagination. The pagination logic is standard for list methods ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the object type. Can take the following values:" }, "order": { "type": "object", "description": "| Sorting list, where the key is the field and the value is `ASC` or `DESC` ||" }, "filter": { "type": "object", "description": "| Filtering list. The filter supports the use of exact values, arrays of values, and modifiers:" }, "select": { "type": "object", "description": "| List of fields to retrieve ||" }, "start": { "type": "integer", "description": "| Offset for pagination. The pagination logic is standard for list methods ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.add": { "post": { "summary": "Create CRM Status Element crm.status.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.add` creates a new element in the specified CRM directory: deal stage, source, company type, and others.", "operationId": "crm_status_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with fields of the new directory element. The list of available fields is described below ||" }, "ENTITY_ID": { "type": "string", "description": "| Type of directory, for example `DEAL_STAGE`, `SOURCE`. You can get the list of types using the method crm.status.entity.types ||" }, "STATUS_ID": { "type": "string", "description": "| Status value code. The code must be unique within the directory. Length and character restrictions depend on the type of directory ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting. Default is 10 ||" }, "COLOR": { "type": "string", "description": "| Hex color code, for example `#39A8EF`. Use for status stages ||" }, "SEMANTICS": { "type": "string", "description": "| Group of stages:" } }, "required": [ "fields", "ENTITY_ID", "STATUS_ID", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with fields of the new directory element. The list of available fields is described below ||" }, "ENTITY_ID": { "type": "string", "description": "| Type of directory, for example `DEAL_STAGE`, `SOURCE`. You can get the list of types using the method crm.status.entity.types ||" }, "STATUS_ID": { "type": "string", "description": "| Status value code. The code must be unique within the directory. Length and character restrictions depend on the type of directory ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting. Default is 10 ||" }, "COLOR": { "type": "string", "description": "| Hex color code, for example `#39A8EF`. Use for status stages ||" }, "SEMANTICS": { "type": "string", "description": "| Group of stages:" } }, "required": [ "fields", "ENTITY_ID", "STATUS_ID", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.delete": { "post": { "summary": "Delete CRM Status Element crm.status.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.delete` removes a status element by its identifier.", "operationId": "crm_status_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the status element to be deleted. You can obtain a list of identifiers using the method crm.status.list ||" }, "params": { "type": "string", "description": "| Available flags:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the status element to be deleted. You can obtain a list of identifiers using the method crm.status.list ||" }, "params": { "type": "string", "description": "| Available flags:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.entity.items": { "post": { "summary": "Get directory items by type crm.status.entity.items", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.entity.items` returns all directory items by the identifier `ENTITY_ID`, sorted by the `SORT` field. This method is similar to [crm.status.list](crm-status-list.md), except that the latter allows you to define sorting rules.", "operationId": "crm_status_entity_items", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-entity-items.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "| Type of the directory, for example `DEAL_STAGE`, `SOURCE`. You can get a list of types using the method crm.status.entity.types ||" } }, "required": [ "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "| Type of the directory, for example `DEAL_STAGE`, `SOURCE`. You can get a list of types using the method crm.status.entity.types ||" } }, "required": [ "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.get": { "post": { "summary": "Get a directory item by ID crm.status.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.get` returns the parameters of a directory item by its ID.", "operationId": "crm_status_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the directory item. You can get a list of items with identifiers using the method crm.status.list ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the directory item. You can get a list of items with identifiers using the method crm.status.list ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.list": { "post": { "summary": "Get a List of Directory Items by Filter crm.status.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.list` returns a list of directory items based on the filter.", "operationId": "crm_status_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.status.update": { "post": { "summary": "Update CRM Status Element crm.status.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.status.update` updates the parameters of an existing CRM status element.", "operationId": "crm_status_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/status/crm-status-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the status element to be updated. You can get the list using the method crm.status.list ||" }, "fields": { "type": "object", "description": "| Array of fields to update. The list of available fields is described below ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "COLOR": { "type": "string", "description": "| Hex color code, for example `#39A8EF` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the status element to be updated. You can get the list using the method crm.status.list ||" }, "fields": { "type": "object", "description": "| Array of fields to update. The list of available fields is described below ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "COLOR": { "type": "string", "description": "| Hex color code, for example `#39A8EF` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.bind": { "post": { "summary": "Add Timeline Record Binding to CRM Entity crm.timeline.bindings.bind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a binding of a timeline record to a CRM entity.", "operationId": "crm_timeline_bindings_bind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/bindings/crm-timeline-bindings-bind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a binding of a timeline record to a CRM entity in the form of a structure:" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier `ID` of the CRM entity to which the comment is linked ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Possible values:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a binding of a timeline record to a CRM entity in the form of a structure:" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier `ID` of the CRM entity to which the comment is linked ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Possible values:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.fields": { "post": { "summary": "Get CRM entity bindings fields and timeline record in crm.timeline.bindings.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of available fields for linking CRM entities and timeline records. No parameters.", "operationId": "crm_timeline_bindings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/bindings/crm-timeline-bindings-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains fields linking timeline records to CRM entities ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record. Read-only ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the CRM entity to which the comment is linked. Immutable ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Immutable. Possible values:" }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains fields linking timeline records to CRM entities ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record. Read-only ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the CRM entity to which the comment is linked. Immutable ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Immutable. Possible values:" }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.list": { "post": { "summary": "Get the list of bindings for a record in the timeline crm.timeline.bindings.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of bindings for a record in the timeline.", "operationId": "crm_timeline_bindings_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/bindings/crm-timeline-bindings-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object for filtering selected records." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object for filtering selected records." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.bindings.unbind": { "post": { "summary": "Unbind Timeline Record from CRM Entity crm.timeline.bindings.unbind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the binding of a timeline record from a CRM entity.", "operationId": "crm_timeline_bindings_unbind", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/bindings/crm-timeline-bindings-unbind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for unbinding the timeline record from the CRM entity in the form of a structure:" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier `ID` of the CRM entity to which the comment is linked ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Possible values:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for unbinding the timeline record from the CRM entity in the form of a structure:" }, "OWNER_ID": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "ENTITY_ID": { "type": "integer", "description": "| Identifier `ID` of the CRM entity to which the comment is linked ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Possible values:" } }, "required": [ "fields", "OWNER_ID", "ENTITY_ID", "ENTITY_TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.add": { "post": { "summary": "Add Comment crm.timeline.comment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new activity of type \"Comment\" to the timeline.", "operationId": "crm_timeline_comment_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new activity of type \"Comment\" in the form of a structure:" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the element to which the comment is attached." }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the system or user-defined type of the CRM object to which the comment is attached. For example: `lead`, `deal`, `contact`, `company`, `order`, `dynamic_1046` ||" }, "COMMENT": { "type": "string", "description": "| The text of the comment ||" }, "FILES": { "type": "string", "description": "| List of files. An array of values described according to the rules ||" } }, "required": [ "fields", "ENTITY_ID", "ENTITY_TYPE", "COMMENT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new activity of type \"Comment\" in the form of a structure:" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the element to which the comment is attached." }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the system or user-defined type of the CRM object to which the comment is attached. For example: `lead`, `deal`, `contact`, `company`, `order`, `dynamic_1046` ||" }, "COMMENT": { "type": "string", "description": "| The text of the comment ||" }, "FILES": { "type": "string", "description": "| List of files. An array of values described according to the rules ||" } }, "required": [ "fields", "ENTITY_ID", "ENTITY_TYPE", "COMMENT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.delete": { "post": { "summary": "Delete Comment crm.timeline.comment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a \"Comment\" type deal.", "operationId": "crm_timeline_comment_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the \"Comment\" type deal (e.g., `1`). Identifiers can be obtained using the `crm.timeline.comment.list` method ||" }, "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the comment is linked (e.g., `2` for a deal) ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the comment is linked (e.g., `1`). A list of identifiers can be obtained using the `crm.timeline.bindings.list` method (field `ENTITY_ID`) ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the \"Comment\" type deal (e.g., `1`). Identifiers can be obtained using the `crm.timeline.comment.list` method ||" }, "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the comment is linked (e.g., `2` for a deal) ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the comment is linked (e.g., `1`). A list of identifiers can be obtained using the `crm.timeline.bindings.list` method (field `ENTITY_ID`) ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.fields": { "post": { "summary": "Get Fields of crm.timeline.comment.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the fields of a \"Comment\" type deal. No parameters required.", "operationId": "crm_timeline_comment_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing all comment fields ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier. Read-only ||" }, "CREATED": { "type": "string", "format": "date-time", "description": "| Date added. Read-only ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the entity to which the comment is linked. Immutable ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Immutable." }, "AUTHOR_ID": { "type": "integer", "description": "| Author. Immutable ||" }, "COMMENT": { "type": "string", "description": "| Comment text ||" }, "FILES": { "type": "string", "description": "| List of files. Array of values described by rules ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing all comment fields ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier. Read-only ||" }, "CREATED": { "type": "string", "format": "date-time", "description": "| Date added. Read-only ||" }, "ENTITY_ID": { "type": "integer", "description": "| `ID` of the entity to which the comment is linked. Immutable ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the entity to which the comment is linked. Immutable." }, "AUTHOR_ID": { "type": "integer", "description": "| Author. Immutable ||" }, "COMMENT": { "type": "string", "description": "| Comment text ||" }, "FILES": { "type": "string", "description": "| List of files. Array of values described by rules ||" }, "Code": { "type": "string", "description": "| Error Message | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.get": { "post": { "summary": "Get Information About the Comment crm.timeline.comment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a comment type deal.", "operationId": "crm_timeline_comment_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the comment type deal (for example, `1`). You can obtain identifiers using the `crm.timeline.comment.list` method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the comment type deal (for example, `1`). You can obtain identifiers using the `crm.timeline.comment.list` method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.list": { "post": { "summary": "Get a List of Comments from crm.timeline.comment.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.comment.list` retrieves a list of all comments associated with a specified CRM entity.", "operationId": "crm_timeline_comment_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected. Pass the fields of the result object. If not provided or an empty array is passed, all fields will be returned. ||" }, "filter": { "type": "object", "description": "| An object for filtering the selected comments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected comments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected. Pass the fields of the result object. If not provided or an empty array is passed, all fields will be returned. ||" }, "filter": { "type": "object", "description": "| An object for filtering the selected comments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected comments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.comment.update": { "post": { "summary": "Update Comment crm.timeline.comment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a \"Comment\" type deal in the timeline.", "operationId": "crm_timeline_comment_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/comments/crm-timeline-comment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the \"Comment\" type deal (e.g., `1`). You can obtain identifiers using the `crm.timeline.comment.list` method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the \"Comment\" type deal in the following structure:" }, "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the comment is attached (e.g., `2` for a deal) ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the comment is attached (e.g., `1`). You can obtain a list of identifiers using the `crm.timeline.bindings.list` method (field `ENTITY_ID`) ||" }, "COMMENT": { "type": "string", "description": "| Text of the comment ||" }, "FILES": { "type": "string", "description": "| List of files. An array of values described according to the rules ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the \"Comment\" type deal (e.g., `1`). You can obtain identifiers using the `crm.timeline.comment.list` method ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the \"Comment\" type deal in the following structure:" }, "ownerTypeId": { "type": "integer", "description": "| Integer identifier of the CRM object type to which the comment is attached (e.g., `2` for a deal) ||" }, "ownerId": { "type": "integer", "description": "| Integer identifier of the CRM entity to which the comment is attached (e.g., `1`). You can obtain a list of identifiers using the `crm.timeline.bindings.list` method (field `ENTITY_ID`) ||" }, "COMMENT": { "type": "string", "description": "| Text of the comment ||" }, "FILES": { "type": "string", "description": "| List of files. An array of values described according to the rules ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.add": { "post": { "summary": "Add Icon to crm.timeline.icon.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new icon.", "operationId": "crm_timeline_icon_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`) ||" }, "fileContent": { "type": "string", "description": "| Base64 encoded content of the icon file." } }, "required": [ "code", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`) ||" }, "fileContent": { "type": "string", "description": "| Base64 encoded content of the icon file." } }, "required": [ "code", "fileContent" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.delete": { "post": { "summary": "Delete Icon crm.timeline.icon.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an icon.", "operationId": "crm_timeline_icon_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.get": { "post": { "summary": "Get Information About the crm.timeline.icon.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about the timeline log entry icon.", "operationId": "crm_timeline_icon_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Icon code (for example, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.icon.list": { "post": { "summary": "Get a List of Available Icons crm.timeline.icon.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of available icons for timeline log entries. No parameters.", "operationId": "crm_timeline_icon_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/icons/crm-timeline-icon-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response." }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response." }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.item.pin": { "post": { "summary": "Pinning an Item in the Timeline crm.timeline.item.pin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.item.pin` pins an item in the timeline.", "operationId": "crm_timeline_item_pin", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/actions/crm-timeline-item-pin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the timeline item, for example `999`. You can obtain the id using the method crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the item is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM element to which the item is linked, for example `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the timeline item, for example `999`. You can obtain the id using the method crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the item is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM element to which the item is linked, for example `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.item.unpin": { "post": { "summary": "Unpin Timeline Item in crm.timeline.item.unpin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.item.unpin` unpins a timeline item.", "operationId": "crm_timeline_item_unpin", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/actions/crm-timeline-item-unpin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the timeline item, for example `999`. You can obtain the id using the method crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the item is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the item is linked, for example `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the timeline item, for example `999`. You can obtain the id using the method crm.timeline.comment.list ||" }, "ownerTypeId": { "type": "integer", "description": "| Identifier of the CRM object type to which the item is linked, for example `2` for a deal ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the CRM entity to which the item is linked, for example `10` ||" } }, "required": [ "id", "ownerTypeId", "ownerId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.delete": { "post": { "summary": "Delete a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.layout.blocks.delete` removes a set of additional content blocks for a timeline record. Within the application, you can only delete the set of additional content blocks that was installed through this application.", "operationId": "crm_timeline_layout_blocks_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM entity type to which the timeline record is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM entity to which the timeline record is linked ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM entity type to which the timeline record is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM entity to which the timeline record is linked ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.get": { "post": { "summary": "Retrieve a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.layout.blocks.get` retrieves a set of additional content blocks for a timeline record. Within the application, you can only obtain the set of additional content blocks that has been established through this application.", "operationId": "crm_timeline_layout_blocks_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM entity type associated with the timeline record ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM entity associated with the timeline record ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM entity type associated with the timeline record ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM entity associated with the timeline record ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" } }, "required": [ "entityTypeId", "entityId", "timelineId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.layout.blocks.set": { "post": { "summary": "Set a Set of Additional Content Blocks in the CRM Timeline Record: crm.timeline.layout.blocks.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.timeline.layout.blocks.set` sets a set of additional content blocks for a timeline record. Setting a new set of additional content blocks in a timeline record will overwrite any previously added set within the same application. The setting of additional content blocks cannot be applied to timeline records related to:", "operationId": "crm_timeline_layout_blocks_set", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/layout-blocks/crm-timeline-layout-blocks-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object to which the timeline record is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the timeline record is linked ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "layout": { "type": "string", "description": "| Object describing the set of additional content blocks ||" } }, "required": [ "entityTypeId", "entityId", "timelineId", "layout" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the CRM object to which the timeline record is linked ||" }, "entityId": { "type": "integer", "description": "| Identifier of the CRM object to which the timeline record is linked ||" }, "timelineId": { "type": "integer", "description": "| Identifier of the timeline record ||" }, "layout": { "type": "string", "description": "| Object describing the set of additional content blocks ||" } }, "required": [ "entityTypeId", "entityId", "timelineId", "layout" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.add": { "post": { "summary": "Add Log Entry crm.timeline.logmessage.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new log entry to the timeline.", "operationId": "crm_timeline_logmessage_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new log entry in the form of a structure:" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the entity type in which the entry will be created ||" }, "entityId": { "type": "integer", "description": "| Identifier of the entity item in which the entry will be created ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "text": { "type": "string", "description": "| Text of the entry ||" }, "iconCode": { "type": "string", "description": "| Icon code." } }, "required": [ "fields", "entityTypeId", "entityId", "title", "text", "iconCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new log entry in the form of a structure:" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the entity type in which the entry will be created ||" }, "entityId": { "type": "integer", "description": "| Identifier of the entity item in which the entry will be created ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "text": { "type": "string", "description": "| Text of the entry ||" }, "iconCode": { "type": "string", "description": "| Icon code." } }, "required": [ "fields", "entityTypeId", "entityId", "title", "text", "iconCode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.delete": { "post": { "summary": "Delete log entry crm.timeline.logmessage.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a timeline log entry. You can only delete a log entry in the context of the [application](https://dev.quickbooks.com/docs/chm_files/app.zip) that created it. This means that only the application that added the entry can delete it. This ensures data security and control.", "operationId": "crm_timeline_logmessage_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the timeline entry (for example, `1`)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the timeline entry (for example, `1`)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.get": { "post": { "summary": "Get Information About the Log Entry crm.timeline.logmessage.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a timeline log entry. It is important to note that the method can only retrieve data about entries that were previously added using [`crm.timeline.logmessage.add`](./crm-timeline-logmessage-add.md). System entries cannot be retrieved using `crm.timeline.logmessage.get`.", "operationId": "crm_timeline_logmessage_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the timeline entry (for example, `1`)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Integer identifier of the timeline entry (for example, `1`)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logmessage.list": { "post": { "summary": "Get a List of Timeline Log Entries crm.timeline.logmessage.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of timeline log entries. It is important to note that the method can only retrieve data for entries that were previously added using [`crm.timeline.logmessage.add`](./crm-timeline-logmessage-add.md). System entries cannot be retrieved using `crm.timeline.logmessage.list`.", "operationId": "crm_timeline_logmessage_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/crm-timeline-logmessage-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the entity type for which to retrieve the list of log entries (e.g., `1` — lead) ||" }, "entityId": { "type": "integer", "description": "| Identifier of the entity item for which to retrieve the list of log entries (e.g., `1`) ||" }, "order": { "type": "object", "description": "| List for sorting, where the key is the field and the value is `asc` or `desc`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "entityTypeId", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the entity type for which to retrieve the list of log entries (e.g., `1` — lead) ||" }, "entityId": { "type": "integer", "description": "| Identifier of the entity item for which to retrieve the list of log entries (e.g., `1`) ||" }, "order": { "type": "object", "description": "| List for sorting, where the key is the field and the value is `asc` or `desc`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "entityTypeId", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.add": { "post": { "summary": "Add Logo crm.timeline.logo.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new logo.", "operationId": "crm_timeline_logo_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (e.g., `info`) ||" }, "fileContent": { "type": "string", "description": "| Base64 encoded content of the logo file." } }, "required": [ "code", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (e.g., `info`) ||" }, "fileContent": { "type": "string", "description": "| Base64 encoded content of the logo file." } }, "required": [ "code", "fileContent" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.delete": { "post": { "summary": "Delete logo crm.timeline.logo.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the logo.", "operationId": "crm_timeline_logo_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (for example, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (for example, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.get": { "post": { "summary": "Get Information About the Logo crm.timeline.logo.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about the logo of the timeline log entry.", "operationId": "crm_timeline_logo_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (for example, `info`)." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Logo code (for example, `info`)." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.logo.list": { "post": { "summary": "Get a list of available logos crm.timeline.logo.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of available logos for timeline log entries. No parameters.", "operationId": "crm_timeline_logo_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/logmessage/logo/crm-timeline-logo-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response." }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response." }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.delete": { "post": { "summary": "Delete Note crm.timeline.note.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a timeline note.", "operationId": "crm_timeline_note_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/note/crm-timeline-note-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the element type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the element to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the deal ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the element type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the element to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the deal ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.get": { "post": { "summary": "Get Information About the Note crm.timeline.note.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns information about a note related to a timeline record.", "operationId": "crm_timeline_note_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/note/crm-timeline-note-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the element type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the element to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the activity ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the element type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the element to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the activity ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.timeline.note.save": { "post": { "summary": "Save Note crm.timeline.note.save", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method allows you to save a note.", "operationId": "crm_timeline_note_save", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/timeline/note/crm-timeline-note-save.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the entity type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the entity to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the activity ||" }, "text": { "type": "string", "description": "| Note text ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ownerTypeId": { "type": "integer", "description": "| Identifier of the entity type to which the record belongs ||" }, "ownerId": { "type": "integer", "description": "| Identifier of the entity to which the record belongs ||" }, "itemType": { "type": "integer", "description": "| Type of the record to which the note should be applied:" }, "itemId": { "type": "integer", "description": "| Identifier of the record to which the note should be applied. If `itemType=1`, this is the identifier of the timeline history record. If `itemType=2`, this is the identifier of the activity ||" }, "text": { "type": "string", "description": "| Note text ||" } }, "required": [ "ownerTypeId", "ownerId", "itemType", "itemId", "text" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.tracking.trace.add": { "post": { "summary": "Create a Sales Intelligence Trace: crm.tracking.trace.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.tracking.trace.add` creates a Sales Intelligence trace and returns its identifier.", "operationId": "crm_tracking_trace_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/tracking/crm-tracking-trace-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITIES": { "type": "string", "description": "| Array of objects to be linked with the trace more details ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITIES": { "type": "string", "description": "| Array of objects to be linked with the trace more details ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.tracking.trace.delete": { "post": { "summary": "Delete Sales Intelligence Trace crm.tracking.trace.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.tracking.trace.delete` removes a Sales Intelligence trace.", "operationId": "crm_tracking_trace_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/tracking/crm-tracking-trace-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.add": { "post": { "summary": "Create a new custom type crm.type.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new SPA.", "operationId": "crm_type_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new SPA ||" }, "title": { "type": "string", "description": "| Title of the SPA | ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the created SPA. If this field is not provided, it will be generated automatically." }, "relations": { "type": "object", "description": "| An object containing links to other CRM entities. The structure is described below | ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Is the use of the SPA in the user field enabled | `N` ||" }, "linkedUserFields": { "type": "object", "description": "| A set of user fields in which this SPA should be displayed. The structure is described below | `{}` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Are Automation rules and triggers enabled | `N` ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Are the Start Date and End Date fields enabled | `N` ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Is the business process designer enabled | `N` ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Are custom sales funnels and tunnels enabled | `N` ||" }, "isClientEnabled": { "type": "boolean", "description": "| Is the Client field enabled. When this option is enabled, the SPA has a preset binding to Contacts and Companies | `N` ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Is document printing enabled | `N` ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Is the binding of catalog products enabled | `N` ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Is the Your Company Details field enabled | `N` ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Is the Observers field enabled | `N` ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Is the use of the recycle bin enabled | `N` ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Should new funnels be available to everyone | `Y` ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Are the Source and Additional Information about Source fields enabled | `N` ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Is the use of custom stages and kanban enabled | `N` ||" }, "isExternal": { "type": "boolean", "description": "| Is the SPA external to the CRM (linked to a digital workplace)" }, "customSectionId": { "type": "integer", "description": "| Identifier of the digital workplace" }, "customSections": { "type": "array", "items": {}, "description": "| Array of digital workplaces" }, "parent": { "type": "string", "description": "| CRM elements that will be linked to this SPA ||" }, "child": { "type": "string", "description": "| CRM elements to which this SPA will be linked ||" }, "isChildrenListEnabled": { "type": "boolean", "description": "| Should the linked element be added to the card." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new SPA ||" }, "title": { "type": "string", "description": "| Title of the SPA | ||" }, "entityTypeId": { "type": "integer", "description": "| Identifier of the created SPA. If this field is not provided, it will be generated automatically." }, "relations": { "type": "object", "description": "| An object containing links to other CRM entities. The structure is described below | ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Is the use of the SPA in the user field enabled | `N` ||" }, "linkedUserFields": { "type": "object", "description": "| A set of user fields in which this SPA should be displayed. The structure is described below | `{}` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Are Automation rules and triggers enabled | `N` ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Are the Start Date and End Date fields enabled | `N` ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Is the business process designer enabled | `N` ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Are custom sales funnels and tunnels enabled | `N` ||" }, "isClientEnabled": { "type": "boolean", "description": "| Is the Client field enabled. When this option is enabled, the SPA has a preset binding to Contacts and Companies | `N` ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Is document printing enabled | `N` ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Is the binding of catalog products enabled | `N` ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Is the Your Company Details field enabled | `N` ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Is the Observers field enabled | `N` ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Is the use of the recycle bin enabled | `N` ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Should new funnels be available to everyone | `Y` ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Are the Source and Additional Information about Source fields enabled | `N` ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Is the use of custom stages and kanban enabled | `N` ||" }, "isExternal": { "type": "boolean", "description": "| Is the SPA external to the CRM (linked to a digital workplace)" }, "customSectionId": { "type": "integer", "description": "| Identifier of the digital workplace" }, "customSections": { "type": "array", "items": {}, "description": "| Array of digital workplaces" }, "parent": { "type": "string", "description": "| CRM elements that will be linked to this SPA ||" }, "child": { "type": "string", "description": "| CRM elements to which this SPA will be linked ||" }, "isChildrenListEnabled": { "type": "boolean", "description": "| Should the linked element be added to the card." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.delete": { "post": { "summary": "Delete user type crm.type.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an existing smart process by the identifier `id`. You can only delete a smart process if there are no associated elements. If such elements exist, they must be deleted first before deleting the smart process.", "operationId": "crm_type_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the smart process. It can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the smart process. It can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.fields": { "post": { "summary": "Get Custom Type Fields crm.type.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about the custom fields of the smart process settings. No parameters.", "operationId": "crm_type_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains an object with a single key `fields` ||" }, "fields": { "type": "object", "description": "| Object in the format: `{ field_1: value_1, field_2: value_2, ... , field_n: value_n }`, where `field_n` — fields of the smart process settings, and `value_n` — object of type `crm_rest_field_description` ||" }, "time": { "type": "string", "description": "| Object containing information about the request execution time ||" }, "Status": { "type": "string", "description": "| Code | Description | Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains an object with a single key `fields` ||" }, "fields": { "type": "object", "description": "| Object in the format: `{ field_1: value_1, field_2: value_2, ... , field_n: value_n }`, where `field_n` — fields of the smart process settings, and `value_n` — object of type `crm_rest_field_description` ||" }, "time": { "type": "string", "description": "| Object containing information about the request execution time ||" }, "Status": { "type": "string", "description": "| Code | Description | Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.get": { "post": { "summary": "Get the user type by id crm.type.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves information about the SPA with the identifier `id`.", "operationId": "crm_type_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the SPA. Can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the SPA. Can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.getByEntityTypeId": { "post": { "summary": "Get the user type by entityTypeId crm.type.getByEntityTypeId", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves information about the SPA with the smart process type identifier `entityTypeId`.", "operationId": "crm_type_getByEntityTypeId", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the smart process type. ||" } }, "required": [ "entityTypeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityTypeId": { "type": "integer", "description": "| Identifier of the smart process type. ||" } }, "required": [ "entityTypeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.list": { "post": { "summary": "Get a list of custom types crm.type.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of smart process settings.", "operationId": "crm_type_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, where" }, "filter": { "type": "object", "description": "| Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, where" }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, where" }, "filter": { "type": "object", "description": "| Object format: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }`, where" }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.type.update": { "post": { "summary": "Update User Type crm.type.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing SPA by its identifier `id`.", "operationId": "crm_type_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-object-types/crm-type-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the SPA. Can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the SPA ||" }, "title": { "type": "string", "description": "| Title of the SPA ||" }, "relations": { "type": "object", "description": "| An object containing links to other CRM entities. The structure is described by the object `type.relations` ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Is the use of the SPA in the user field enabled ||" }, "linkedUserFields": { "type": "object", "description": "| A set of user fields in which this SPA should be displayed. The structure is described by the object `type.linkedUserFields` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Are automation rules and triggers enabled ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Are the Start Date and End Date fields enabled ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Is the use of the business process designer enabled ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Are custom Sales Funnels and sales tunnels enabled ||" }, "isClientEnabled": { "type": "boolean", "description": "| Is the Client field enabled. When this option is enabled, the SPA has a preset link to Contacts and Companies ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Is document printing enabled ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Is the link to catalog products enabled ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Is the Your Company Details field enabled ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Is the Observers field enabled ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Is the use of the recycle bin enabled ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Should new funnels be made available to everyone ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Are the Source and Additional Information about Source fields enabled ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Is the use of custom stages and Kanban enabled ||" }, "isExternal": { "type": "boolean", "description": "| Is the SPA external to the CRM (linked to a digital workplace)" }, "customSectionId": { "type": "integer", "description": "| Identifier of the digital workplace" }, "customSections": { "type": "array", "items": {}, "description": "| Array of digital workplaces" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the SPA. Can be obtained using the methods: `crm.type.list`, `crm.type.add` ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the SPA ||" }, "title": { "type": "string", "description": "| Title of the SPA ||" }, "relations": { "type": "object", "description": "| An object containing links to other CRM entities. The structure is described by the object `type.relations` ||" }, "isUseInUserfieldEnabled": { "type": "boolean", "description": "| Is the use of the SPA in the user field enabled ||" }, "linkedUserFields": { "type": "object", "description": "| A set of user fields in which this SPA should be displayed. The structure is described by the object `type.linkedUserFields` ||" }, "isAutomationEnabled": { "type": "boolean", "description": "| Are automation rules and triggers enabled ||" }, "isBeginCloseDatesEnabled": { "type": "boolean", "description": "| Are the Start Date and End Date fields enabled ||" }, "isBizProcEnabled": { "type": "boolean", "description": "| Is the use of the business process designer enabled ||" }, "isCategoriesEnabled": { "type": "boolean", "description": "| Are custom Sales Funnels and sales tunnels enabled ||" }, "isClientEnabled": { "type": "boolean", "description": "| Is the Client field enabled. When this option is enabled, the SPA has a preset link to Contacts and Companies ||" }, "isDocumentsEnabled": { "type": "boolean", "description": "| Is document printing enabled ||" }, "isLinkWithProductsEnabled": { "type": "boolean", "description": "| Is the link to catalog products enabled ||" }, "isMycompanyEnabled": { "type": "boolean", "description": "| Is the Your Company Details field enabled ||" }, "isObserversEnabled": { "type": "boolean", "description": "| Is the Observers field enabled ||" }, "isRecyclebinEnabled": { "type": "boolean", "description": "| Is the use of the recycle bin enabled ||" }, "isSetOpenPermissions": { "type": "boolean", "description": "| Should new funnels be made available to everyone ||" }, "isSourceEnabled": { "type": "boolean", "description": "| Are the Source and Additional Information about Source fields enabled ||" }, "isStagesEnabled": { "type": "boolean", "description": "| Is the use of custom stages and Kanban enabled ||" }, "isExternal": { "type": "boolean", "description": "| Is the SPA external to the CRM (linked to a digital workplace)" }, "customSectionId": { "type": "integer", "description": "| Identifier of the digital workplace" }, "customSections": { "type": "array", "items": {}, "description": "| Array of digital workplaces" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.enumeration.fields": { "post": { "summary": "Get Field Descriptions for Custom Field Type \"Enumeration\" (List) crm.userfield.enumeration.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.userfield.enumeration.fields` returns field descriptions for a custom field of type \"enumeration\" (list).", "operationId": "crm_userfield_enumeration_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-fields/crm-userfield-enumeration-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.fields": { "post": { "summary": "Get Description for Custom Fields crm.userfield.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.userfield.fields` returns a description of the characteristics of custom fields.", "operationId": "crm_userfield_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-fields/crm-userfield-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.settings.fields": { "post": { "summary": "Get Field Settings Description for Custom Field Type crm.userfield.settings.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.userfield.settings.fields` returns the field settings description for the specified custom field type.", "operationId": "crm_userfield_settings_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-fields/crm-userfield-settings-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| The type of the custom field. A value from the list returned by the method crm.userfield.types ||" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| The type of the custom field. A value from the list returned by the method crm.userfield.types ||" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.userfield.types": { "post": { "summary": "Get a list of custom field types crm.userfield.types", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.userfield.types` retrieves the available types of custom fields. The types returned are: - `string` — string", "operationId": "crm_userfield_types", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/user-defined-fields/crm-userfield-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.add": { "post": { "summary": "Create VAT Rate crm.vat.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.vat.add](../../../catalog/vat/catalog-vat-add.md). The method `crm.vat.add` creates a new VAT rate in the CRM.", "operationId": "crm_vat_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "ACTIVE": { "type": "string", "description": "| Activity of the rate:" }, "C_SORT": { "type": "integer", "description": "| Sorting." }, "NAME": { "type": "string", "description": "| Name of the rate ||" }, "RATE": { "type": "number", "format": "double", "description": "| Value of the VAT rate, % ||" } }, "required": [ "fields", "NAME", "RATE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object format:" }, "ACTIVE": { "type": "string", "description": "| Activity of the rate:" }, "C_SORT": { "type": "integer", "description": "| Sorting." }, "NAME": { "type": "string", "description": "| Name of the rate ||" }, "RATE": { "type": "number", "format": "double", "description": "| Value of the VAT rate, % ||" } }, "required": [ "fields", "NAME", "RATE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.delete": { "post": { "summary": "Delete VAT Rate crm.vat.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been discontinued. Please use [catalog.vat.delete](../../../catalog/vat/catalog-vat-delete.md). The method `crm.vat.delete` removes a VAT rate by its identifier.", "operationId": "crm_vat_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the VAT rate to be deleted." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the VAT rate to be deleted." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.fields": { "post": { "summary": "Get VAT Rate Fields crm.vat.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.vat.getFields](../../../catalog/vat/catalog-vat-get-fields.md). The method `crm.vat.fields` returns a description of the VAT rate fields.", "operationId": "crm_vat_fields", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.get": { "post": { "summary": "Get VAT Rate by ID crm.vat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [catalog.vat.get](../../../catalog/vat/catalog-vat-get.md). The method `crm.vat.get` returns the parameters of the VAT rate by its ID.", "operationId": "crm_vat_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the VAT rate. You can obtain a list of rates using the crm.vat.list method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the VAT rate. You can obtain a list of rates using the crm.vat.list method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.list": { "post": { "summary": "Get a List of VAT Rates by Filter crm.vat.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.vat.list](../../../catalog/vat/catalog-vat-list.md). The method `crm.vat.list` returns a list of VAT rates based on a filter. It is an implementation of the [list method](../../../../settings/how-to-call-rest-api/list-methods-pecularities.md) for VAT rates.", "operationId": "crm_vat_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" }, "select": { "type": "array", "items": {}, "description": "| An array of fields to return. If not specified, all fields will be returned ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" }, "select": { "type": "array", "items": {}, "description": "| An array of fields to return. If not specified, all fields will be returned ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/crm.vat.update": { "post": { "summary": "Update Existing VAT Rate crm.vat.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [catalog.vat.update](../../../catalog/vat/catalog-vat-update.md). The method `crm.vat.update` updates the parameters of an existing VAT rate.", "operationId": "crm_vat_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/outdated/vat/crm-vat-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the VAT rate to be updated. You can retrieve the list of rates using the crm.vat.list method ||" }, "fields": { "type": "object", "description": "| Array of fields to update. The list of available fields is described below ||" }, "ACTIVE": { "type": "string", "description": "| Activity status of the rate:" }, "C_SORT": { "type": "integer", "description": "| Sorting ||" }, "NAME": { "type": "string", "description": "| Name of the rate ||" }, "RATE": { "type": "number", "format": "double", "description": "| Value of the VAT rate, % ||" } }, "required": [ "id", "fields", "NAME", "RATE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the VAT rate to be updated. You can retrieve the list of rates using the crm.vat.list method ||" }, "fields": { "type": "object", "description": "| Array of fields to update. The list of available fields is described below ||" }, "ACTIVE": { "type": "string", "description": "| Activity status of the rate:" }, "C_SORT": { "type": "integer", "description": "| Sorting ||" }, "NAME": { "type": "string", "description": "| Name of the rate ||" }, "RATE": { "type": "number", "format": "double", "description": "| Value of the VAT rate, % ||" } }, "required": [ "id", "fields", "NAME", "RATE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/ctrigger.delete": { "post": { "summary": "Delete Trigger ctrigger.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a trigger. The method can only be executed in the application context.", "operationId": "ctrigger_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/automation/triggers/crm-automation-trigger-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]` ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\\.\\-_]` ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "crm" ] } ] } }, "/department.add": { "post": { "summary": "Create Department department.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `department.add` adds a new department to the company's structure.", "operationId": "department_add", "tags": [ "Company Structure" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/departments/department-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Department name ||" }, "SORT": { "type": "integer", "description": "| Department sorting field ||" }, "PARENT": { "type": "integer", "description": "| Identifier of the parent department ||" }, "UF_HEAD": { "type": "integer", "description": "| Identifier of the user who will become the head of the department ||" } }, "required": [ "NAME", "PARENT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Department name ||" }, "SORT": { "type": "integer", "description": "| Department sorting field ||" }, "PARENT": { "type": "integer", "description": "| Identifier of the parent department ||" }, "UF_HEAD": { "type": "integer", "description": "| Identifier of the user who will become the head of the department ||" } }, "required": [ "NAME", "PARENT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.department.delete": { "post": { "summary": "Delete department.department.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `department.delete` removes a department from the company structure.", "operationId": "department_department_delete", "tags": [ "Company Structure" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/departments/department-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the department ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the department ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.fields": { "post": { "summary": "Get a list of department field names department.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `department.fields` returns a list and description of available department fields. No parameters.", "operationId": "department_fields", "tags": [ "Company Structure" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/departments/department-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains the list and description of fields ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response. Contains the list and description of fields ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.get": { "post": { "summary": "Get the list of departments department.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `department.get` method is designed to retrieve a list of departments.", "operationId": "department_get", "tags": [ "Company Structure" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/departments/department-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "type": "string", "description": "| The name of the field to sort by. Sorting works on the following fields:" }, "order": { "type": "string", "description": "| Sorting direction:" }, "ID": { "type": "integer", "description": "| Filter by department identifier ||" }, "NAME": { "type": "string", "description": "| Filter by department name. The full name of the department should be specified ||" }, "SORT": { "type": "integer", "description": "| Filter by sorting field ||" }, "PARENT": { "type": "integer", "description": "| Filter by parent department identifier ||" }, "UF_HEAD": { "type": "integer", "description": "| Filter by department head identifier ||" }, "START": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sort": { "type": "string", "description": "| The name of the field to sort by. Sorting works on the following fields:" }, "order": { "type": "string", "description": "| Sorting direction:" }, "ID": { "type": "integer", "description": "| Filter by department identifier ||" }, "NAME": { "type": "string", "description": "| Filter by department name. The full name of the department should be specified ||" }, "SORT": { "type": "integer", "description": "| Filter by sorting field ||" }, "PARENT": { "type": "integer", "description": "| Filter by parent department identifier ||" }, "UF_HEAD": { "type": "integer", "description": "| Filter by department head identifier ||" }, "START": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/department.update": { "post": { "summary": "Update Department department.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `department.update` modifies the department data in the company structure.", "operationId": "department_update", "tags": [ "Company Structure" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/departments/department-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the department ||" }, "NAME": { "type": "string", "description": "| Name of the department ||" }, "SORT": { "type": "integer", "description": "| Sorting field of the department ||" }, "PARENT": { "type": "integer", "description": "| Identifier of the parent department ||" }, "UF_HEAD": { "type": "integer", "description": "| Identifier of the user who will be the head of the department ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the department ||" }, "NAME": { "type": "string", "description": "| Name of the department ||" }, "SORT": { "type": "integer", "description": "| Sorting field of the department ||" }, "PARENT": { "type": "integer", "description": "| Identifier of the parent department ||" }, "UF_HEAD": { "type": "integer", "description": "| Identifier of the user who will be the head of the department ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "department" ] } ] } }, "/disk.attachedObject.get": { "post": { "summary": "Get Information About Attached File disk.attachedObject.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.attachedObject.get` returns information about the attached file.", "operationId": "disk_attachedObject_get", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/attached-object/disk-attached-object-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file attachment record, which is the link connecting the disk file with other objects." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file attachment record, which is the link connecting the disk file with other objects." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.copyto": { "post": { "summary": "Copy File to Specified Folder disk.file.copyto", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.copyto` copies a file to the specified folder.", "operationId": "disk_file_copyto", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-copy-to.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the folder to which the file is copied ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the folder to which the file is copied ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.delete": { "post": { "summary": "Permanently Delete File disk.file.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.delete` permanently deletes a file. If you want to move the file to the trash, use the method [disk.file.markdeleted](./disk-file-mark-deleted.md).", "operationId": "disk_file_delete", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.get": { "post": { "summary": "Get File Parameters disk.file.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.get` returns data about a file.", "operationId": "disk_file_get", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getExternalLink": { "post": { "summary": "Get Public Link for File disk.file.getExternalLink", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.getExternalLink` returns a public link to a file.", "operationId": "disk_file_getExternalLink", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-get-external-link.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getVersions": { "post": { "summary": "List of File Versions for disk.file.getVersions", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.getVersions` returns a list of file versions. Versions are returned in descending order of creation date.", "operationId": "disk_file_getVersions", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-get-versions.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." }, "filter": { "type": "array", "items": {}, "description": "| An array in the following format:" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." }, "filter": { "type": "array", "items": {}, "description": "| An array in the following format:" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.getfields": { "post": { "summary": "Get Description of File Fields for disk.file.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.getfields` returns the description of file fields.", "operationId": "disk_file_getfields", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.markdeleted": { "post": { "summary": "Move File to Trash disk.file.markdeleted", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.markdeleted` moves a file to the trash. Save the file ID after deletion so that it can be restored later using the [disk.file.restore](./disk-file-restore.md) method.", "operationId": "disk_file_markdeleted", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-mark-deleted.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.moveto": { "post": { "summary": "Move File to Specified Folder disk.file.moveto", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.moveto` moves a file to the specified folder. You cannot move a file to a folder from a different storage.", "operationId": "disk_file_moveto", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-move-to.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the folder to which the file should be moved ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the folder to which the file should be moved ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.rename": { "post": { "summary": "Rename File disk.file.rename", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.rename` renames a file.", "operationId": "disk_file_rename", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-rename.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." }, "newName": { "type": "string", "description": "| New file name." } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." }, "newName": { "type": "string", "description": "| New file name." } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.restore": { "post": { "summary": "Restore File from Trash disk.file.restore", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.restore` restores a file from the trash.", "operationId": "disk_file_restore", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-restore.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file located in the trash." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file located in the trash." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.restoreFromVersion": { "post": { "summary": "Restore a File from a Specific Version disk.file.restoreFromVersion", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.restoreFromVersion` restores a file from a specific version.", "operationId": "disk_file_restoreFromVersion", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-restore-from-version.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." }, "versionId": { "type": "integer", "description": "| Identifier of the file version." } }, "required": [ "id", "versionId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file." }, "versionId": { "type": "integer", "description": "| Identifier of the file version." } }, "required": [ "id", "versionId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.file.uploadversion": { "post": { "summary": "Upload a New Version of a File disk.file.uploadversion", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.file.uploadversion` uploads a new version of a file.", "operationId": "disk_file_uploadversion", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/file/disk-file-upload-version.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string in Base64 ||" } }, "required": [ "id", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| File identifier." }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string in Base64 ||" } }, "required": [ "id", "fileContent" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.addsubfolder": { "post": { "summary": "Create a Subfolder disk.folder.addsubfolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.addsubfolder` creates a subfolder.", "operationId": "disk_folder_addsubfolder", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-add-subfolder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the parent folder." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the subfolder ||" } }, "required": [ "id", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the parent folder." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the subfolder ||" } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.copyto": { "post": { "summary": "Copy a folder and all its contents to the specified folder disk.folder.copyto", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.copyto` copies a folder and all its contents to the specified folder.", "operationId": "disk_folder_copyto", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-copy-to.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source folder to be copied." }, "targetFolderId": { "type": "integer", "description": "| Identifier of the target folder where the folder is copied ||" } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source folder to be copied." }, "targetFolderId": { "type": "integer", "description": "| Identifier of the target folder where the folder is copied ||" } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.deletetree": { "post": { "summary": "Permanently Delete a Folder and All Its Contents disk.folder.deletetree", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.deletetree` permanently deletes a folder and all its contents. If you want to move the folder to the trash, use the method [disk.folder.markdeleted](./disk-folder-mark-deleted.md).", "operationId": "disk_folder_deletetree", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-delete-tree.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.get": { "post": { "summary": "Get Folder Parameters disk.folder.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.get` returns data about a folder.", "operationId": "disk_folder_get", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getchildren": { "post": { "summary": "Get a list of files and folders in the folder disk.folder.getchildren", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.getchildren` returns a list of files and folders located in the folder. Only those files and folders for which the user has \"Read\" access permission are returned.", "operationId": "disk_folder_getchildren", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-get-children.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getexternallink": { "post": { "summary": "Get Public Link for Folder disk.folder.getexternallink", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.getexternallink` returns a public link to the folder.", "operationId": "disk_folder_getexternallink", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-get-external-link.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.getfields": { "post": { "summary": "Get Folder Field Descriptions disk.folder.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.getfields` returns the description of folder fields.", "operationId": "disk_folder_getfields", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.markdeleted": { "post": { "summary": "Move Folder to Trash disk.folder.markdeleted", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.markdeleted` moves a folder to the trash. Save the folder ID after deletion so that it can be restored later using the method [disk.folder.restore](./disk-folder-restore.md)", "operationId": "disk_folder_markdeleted", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-mark-deleted.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.moveto": { "post": { "summary": "Move a folder and all its contents to the specified folder disk.folder.moveto", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.moveto` moves a folder and all its contents to the specified folder.", "operationId": "disk_folder_moveto", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-move-to.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source folder to be moved ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the target folder to which the folder is moved." } }, "required": [ "id", "targetFolderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the source folder to be moved ||" }, "targetFolderId": { "type": "integer", "description": "| Identifier of the target folder to which the folder is moved." } }, "required": [ "id", "targetFolderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.rename": { "post": { "summary": "Rename Folder disk.folder.rename", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.rename` renames a folder.", "operationId": "disk_folder_rename", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-rename.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "newName": { "type": "string", "description": "| New name of the folder ||" } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "newName": { "type": "string", "description": "| New name of the folder ||" } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.restore": { "post": { "summary": "Restore Folder from Trash disk.folder.restore", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.restore` restores a folder from the trash.", "operationId": "disk_folder_restore", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-restore.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder located in the trash." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder located in the trash." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.sharetouser": { "post": { "summary": "Assign Access Permissions to Folder disk.folder.sharetouser", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.sharetouser` assigns access permissions to a folder.", "operationId": "disk_folder_sharetouser", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-share-to-user.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "userId": { "type": "integer", "description": "| Identifier of the user to whom access is granted." }, "taskName": { "type": "string", "description": "| Level of access granted to the user. Possible values:" } }, "required": [ "id", "userId", "taskName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder." }, "userId": { "type": "integer", "description": "| Identifier of the user to whom access is granted." }, "taskName": { "type": "string", "description": "| Level of access granted to the user. Possible values:" } }, "required": [ "id", "userId", "taskName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.folder.uploadfile": { "post": { "summary": "Upload a New File to the Specified Folder disk.folder.uploadfile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.folder.uploadfile` uploads a new file to the specified folder.", "operationId": "disk_folder_uploadfile", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/folder/disk-folder-upload-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder where the file needs to be uploaded." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the file." }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string with Base64." }, "rights": { "type": "array", "items": {}, "description": "| An array of access permissions for the uploaded file in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" }, "generateUniqueName": { "type": "boolean", "description": "| Generate a unique file name if a file with that name already exists. For example, file (1).docx." } }, "required": [ "id", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the folder where the file needs to be uploaded." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the file." }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string with Base64." }, "rights": { "type": "array", "items": {}, "description": "| An array of access permissions for the uploaded file in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" }, "generateUniqueName": { "type": "boolean", "description": "| Generate a unique file name if a file with that name already exists. For example, file (1).docx." } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.rights.getTasks": { "post": { "summary": "Get a List of Available Access Levels disk.rights.getTasks", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.rights.getTasks` returns a list of available access levels. Use the obtained access level identifiers to set permissions on files during their upload. Specify the identifiers as the value of the `TASK_ID` parameter in the methods [disk.storage.uploadfile](../storage/disk-storage-upload-file.md) and [disk.folder.uploadfile](../folder/disk-folder-upload-file.md).", "operationId": "disk_rights_getTasks", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/rights/disk-rights-get-tasks.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.addfolder": { "post": { "summary": "Create a Folder in the Root of the Storage disk.storage.addfolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.addfolder` creates a folder in the root of the storage.", "operationId": "disk_storage_addfolder", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-add-folder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage." }, "data": { "type": "array", "items": {}, "description": "| Array with the field `NAME`, where `NAME` is the name of the new folder ||" }, "rights": { "type": "array", "items": {}, "description": "| Array of access permissions for the folder in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" } }, "required": [ "id", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage." }, "data": { "type": "array", "items": {}, "description": "| Array with the field `NAME`, where `NAME` is the name of the new folder ||" }, "rights": { "type": "array", "items": {}, "description": "| Array of access permissions for the folder in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" } }, "required": [ "id", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.get": { "post": { "summary": "Get Storage Description disk.storage.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.get` returns storage data.", "operationId": "disk_storage_get", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Storage identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Storage identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getchildren": { "post": { "summary": "Get a list of files and folders in the root of the storage disk.storage.getchildren", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.getchildren` returns a list of files and folders located in the root of the storage. Only those files and folders for which the user has \"Read\" access permission are returned.", "operationId": "disk_storage_getchildren", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get-children.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage." }, "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage." }, "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getfields": { "post": { "summary": "Get Description of Storage Fields disk.storage.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.getfields` returns the description of storage fields.", "operationId": "disk_storage_getfields", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getforapp": { "post": { "summary": "Get Application Storage Description disk.storage.getforapp", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.getforapp` returns the description of the storage associated with the application. If the storage does not exist, it creates one. The method works only in the context of the [application](../../../settings/app-installation/index.md)", "operationId": "disk_storage_getforapp", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get-for-app.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.getlist": { "post": { "summary": "Get a List of Available Storages disk.storage.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.getlist` returns a list of available storages.", "operationId": "disk_storage_getlist", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Array format:" }, "order": { "type": "array", "items": {}, "description": "| Array format:" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.gettypes": { "post": { "summary": "Get Storage Types disk.storage.gettypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.gettypes` returns a list of storage types.", "operationId": "disk_storage_gettypes", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-get-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.rename": { "post": { "summary": "Rename Application Storage disk.storage.rename", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.rename` renames the application storage. The method works only in the context of the [application](../../../settings/app-installation/index.md)", "operationId": "disk_storage_rename", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-rename.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the application storage." }, "newName": { "type": "string", "description": "| New name for the storage ||" } }, "required": [ "id", "newName" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the application storage." }, "newName": { "type": "string", "description": "| New name for the storage ||" } }, "required": [ "id", "newName" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.storage.uploadfile": { "post": { "summary": "Upload a New File to the Root of the Storage disk.storage.uploadfile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.storage.uploadfile` uploads a new file to the root of the storage.", "operationId": "disk_storage_uploadfile", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/storage/disk-storage-upload-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage where the file needs to be uploaded." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the file ||" }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string with Base64 ||" }, "rights": { "type": "array", "items": {}, "description": "| An array of access permissions for the uploaded file in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" }, "generateUniqueName": { "type": "boolean", "description": "| Generate a unique file name if a file with that name already exists. For example, file (1).docx." } }, "required": [ "id", "data", "fileContent" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the storage where the file needs to be uploaded." }, "data": { "type": "array", "items": {}, "description": "| An array with the field `NAME`, where `NAME` is the name of the file ||" }, "fileContent": { "type": "array", "items": {}, "description": "| An array containing the file name and a string with Base64 ||" }, "rights": { "type": "array", "items": {}, "description": "| An array of access permissions for the uploaded file in the format `{\"TASK_ID\": 42, \"ACCESS_CODE\": \"U35\"}`, where" }, "generateUniqueName": { "type": "boolean", "description": "| Generate a unique file name if a file with that name already exists. For example, file (1).docx." } }, "required": [ "id", "data", "fileContent" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/disk.version.get": { "post": { "summary": "Get File Version disk.version.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `disk.version.get` returns the version of a file.", "operationId": "disk_version_get", "tags": [ "Drive" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/disk/version/disk-version-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file version." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the file version." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "disk" ] } ] } }, "/documentgenerator.document.add": { "post": { "summary": "Create a New Document Based on a Template documentgenerator.document.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.add` creates a new document based on a template.", "operationId": "documentgenerator_document_add", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Template identifier." }, "providerClassName": { "type": "string", "description": "| Data provider class." }, "value": { "type": "string", "description": "| External identifier of the object for which the document is being generated." }, "values": { "type": "object", "description": "| Field values of the document in the format `{\"FieldCode\":\"Value\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Seal and signature mode:" }, "fields": { "type": "object", "description": "| Description of how to interpret and format values from `values` (detailed description)." }, "TYPE": { "type": "string", "description": "| Field type." }, "FORMAT": { "type": "object", "description": "| Formatting parameters for the field type." }, "PROVIDER": { "type": "string", "description": "| Provider class ||" }, "TITLE": { "type": "string", "description": "| Field title ||" } }, "required": [ "templateId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Template identifier." }, "providerClassName": { "type": "string", "description": "| Data provider class." }, "value": { "type": "string", "description": "| External identifier of the object for which the document is being generated." }, "values": { "type": "object", "description": "| Field values of the document in the format `{\"FieldCode\":\"Value\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Seal and signature mode:" }, "fields": { "type": "object", "description": "| Description of how to interpret and format values from `values` (detailed description)." }, "TYPE": { "type": "string", "description": "| Field type." }, "FORMAT": { "type": "object", "description": "| Formatting parameters for the field type." }, "PROVIDER": { "type": "string", "description": "| Provider class ||" }, "TITLE": { "type": "string", "description": "| Field title ||" } }, "required": [ "templateId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.delete": { "post": { "summary": "Delete document documentgenerator.document.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.delete` removes a document by its identifier.", "operationId": "documentgenerator_document_delete", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.enablepublicurl": { "post": { "summary": "Enable or disable public link for document documentgenerator.document.enablepublicurl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.enablepublicurl` enables or disables the public link for a document.", "operationId": "documentgenerator_document_enablepublicurl", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-enable-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "status": { "type": "integer", "description": "| Status of the public link:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "status": { "type": "integer", "description": "| Status of the public link:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.get": { "post": { "summary": "Get Document by ID documentgenerator.document.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.get` returns information about a document by its ID.", "operationId": "documentgenerator_document_get", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document ID." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document ID." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.getfields": { "post": { "summary": "Get the list of fields for the document documentgenerator.document.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.getfields` returns the fields of the document, along with their current and base values.", "operationId": "documentgenerator_document_getfields", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "values": { "type": "object", "description": "| Optional parameter." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "values": { "type": "object", "description": "| Optional parameter." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.list": { "post": { "summary": "Get the List of Documents documentgenerator.document.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.list` returns a list of documents based on the filter.", "operationId": "documentgenerator_document_list", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to return." }, "order": { "type": "object", "description": "| An object for sorting documents in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering documents in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." }, "id": { "type": "integer", "description": "| Document identifier ||" }, "title": { "type": "string", "description": "| Document title ||" }, "number": { "type": "string", "description": "| Document number ||" }, "templateId": { "type": "integer", "description": "| Template identifier ||" }, "provider": { "type": "string", "description": "| Provider class ||" }, "value": { "type": "string", "description": "| External identifier of the object ||" }, "fileId": { "type": "integer", "description": "| Identifier of the document's DOCX file ||" }, "imageId": { "type": "integer", "description": "| Identifier of the document's image file ||" }, "pdfId": { "type": "integer", "description": "| Identifier of the document's PDF file ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Document creation time ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Document update time ||" }, "values": { "type": "object", "description": "| Document field values ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the document ||" }, "updatedBy": { "type": "integer", "description": "| Identifier of the user who updated the document ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to return." }, "order": { "type": "object", "description": "| An object for sorting documents in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering documents in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." }, "id": { "type": "integer", "description": "| Document identifier ||" }, "title": { "type": "string", "description": "| Document title ||" }, "number": { "type": "string", "description": "| Document number ||" }, "templateId": { "type": "integer", "description": "| Template identifier ||" }, "provider": { "type": "string", "description": "| Provider class ||" }, "value": { "type": "string", "description": "| External identifier of the object ||" }, "fileId": { "type": "integer", "description": "| Identifier of the document's DOCX file ||" }, "imageId": { "type": "integer", "description": "| Identifier of the document's image file ||" }, "pdfId": { "type": "integer", "description": "| Identifier of the document's PDF file ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Document creation time ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Document update time ||" }, "values": { "type": "object", "description": "| Document field values ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the document ||" }, "updatedBy": { "type": "integer", "description": "| Identifier of the user who updated the document ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.document.update": { "post": { "summary": "Update Existing Document documentgenerator.document.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.document.update` updates a document with new field values.", "operationId": "documentgenerator_document_update", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/document-generator-document-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "values": { "type": "object", "description": "| Field values of the document in the format `{\"FieldCode\":\"Value\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Stamp and signature mode:" }, "fields": { "type": "object", "description": "| Description of how to interpret and format values from `values` (detailed description)." }, "TYPE": { "type": "string", "description": "| Field type." }, "FORMAT": { "type": "object", "description": "| Formatting parameters for the field type." }, "PROVIDER": { "type": "string", "description": "| Provider class ||" }, "TITLE": { "type": "string", "description": "| Field title ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Document identifier." }, "values": { "type": "object", "description": "| Field values of the document in the format `{\"FieldCode\":\"Value\"}` ||" }, "stampsEnabled": { "type": "integer", "description": "| Stamp and signature mode:" }, "fields": { "type": "object", "description": "| Description of how to interpret and format values from `values` (detailed description)." }, "TYPE": { "type": "string", "description": "| Field type." }, "FORMAT": { "type": "object", "description": "| Formatting parameters for the field type." }, "PROVIDER": { "type": "string", "description": "| Provider class ||" }, "TITLE": { "type": "string", "description": "| Field title ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.add": { "post": { "summary": "Add Document Generator Numerator: documentgenerator.numerator.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.numerator.add` creates a document numerator.", "operationId": "documentgenerator_numerator_add", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/numerators/document-generator-numerator-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of numerator parameters (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the numerator ||" }, "template": { "type": "string", "description": "| Number template with the placeholder `{NUMBER}`." }, "settings": { "type": "object", "description": "| Settings for the numerator generators (detailed description) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering (detailed description) ||" }, "start": { "type": "integer", "description": "| Initial counter value." }, "step": { "type": "integer", "description": "| Counter increment step." }, "length": { "type": "integer", "description": "| Minimum length of the number." }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`." }, "periodicBy": { "type": "string", "description": "| Counter reset period:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, e.g., `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Direct numbering flag." } }, "required": [ "fields", "name", "template" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of numerator parameters (detailed description) ||" }, "name": { "type": "string", "description": "| Name of the numerator ||" }, "template": { "type": "string", "description": "| Number template with the placeholder `{NUMBER}`." }, "settings": { "type": "object", "description": "| Settings for the numerator generators (detailed description) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering (detailed description) ||" }, "start": { "type": "integer", "description": "| Initial counter value." }, "step": { "type": "integer", "description": "| Counter increment step." }, "length": { "type": "integer", "description": "| Minimum length of the number." }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`." }, "periodicBy": { "type": "string", "description": "| Counter reset period:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, e.g., `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Direct numbering flag." } }, "required": [ "fields", "name", "template" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.delete": { "post": { "summary": "Delete the documentgenerator.numerator.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.numerator.delete` removes a numerator by its identifier. You can only delete a numerator that was created using the `documentgenerator.numerator.add` method.", "operationId": "documentgenerator_numerator_delete", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/numerators/document-generator-numerator-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.get": { "post": { "summary": "Get Numerator by ID documentgenerator.numerator.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.numerator.get` returns the numerator data by its ID.", "operationId": "documentgenerator_numerator_get", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/numerators/document-generator-numerator-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the numerator." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the numerator." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.list": { "post": { "summary": "Get the List of Numerators documentgenerator.numerator.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.numerator.list` returns a list of numerators for the document generator. It retrieves all numerators available in the current Bitrix24, including [CRM numerators](../../crm/document-generator/numerator/index.md).", "operationId": "documentgenerator_numerator_list", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/numerators/document-generator-numerator-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.numerator.update": { "post": { "summary": "Update the documentgenerator.numerator.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.numerator.update` updates the numerator by its identifier. You can only update a numerator that was created through the REST method `documentgenerator.numerator.add`.", "operationId": "documentgenerator_numerator_update", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/numerators/document-generator-numerator-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator." }, "fields": { "type": "object", "description": "| Set of fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| New name of the numerator ||" }, "template": { "type": "string", "description": "| New number template with the placeholder `{NUMBER}`." }, "settings": { "type": "object", "description": "| Updated generator settings (detailed description) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering (detailed description) ||" }, "start": { "type": "integer", "description": "| Initial counter value. Default is `1` ||" }, "step": { "type": "integer", "description": "| Counter increment step. Default is `1` ||" }, "length": { "type": "integer", "description": "| Minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`. Default is `0` ||" }, "periodicBy": { "type": "string", "description": "| Counter reset period:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, e.g., `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Direct numbering flag." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the numerator." }, "fields": { "type": "object", "description": "| Set of fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| New name of the numerator ||" }, "template": { "type": "string", "description": "| New number template with the placeholder `{NUMBER}`." }, "settings": { "type": "object", "description": "| Updated generator settings (detailed description) ||" }, "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": { "type": "object", "description": "| Settings for sequential numbering (detailed description) ||" }, "start": { "type": "integer", "description": "| Initial counter value. Default is `1` ||" }, "step": { "type": "integer", "description": "| Counter increment step. Default is `1` ||" }, "length": { "type": "integer", "description": "| Minimum length of the number. Default is `0` ||" }, "padString": { "type": "string", "description": "| Padding character on the left when `length > 0`. Default is `0` ||" }, "periodicBy": { "type": "string", "description": "| Counter reset period:" }, "timezone": { "type": "string", "description": "| Timezone identifier for periodic reset, e.g., `Europe/Berlin` ||" }, "isDirectNumeration": { "type": "boolean", "description": "| Direct numbering flag." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.add": { "post": { "summary": "Add Region documentgenerator.region.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.region.add` adds a new custom region.", "operationId": "documentgenerator_region_add", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/region/document-generator-region-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Region parameters (detailed description) ||" }, "title": { "type": "string", "description": "| Region name ||" }, "languageId": { "type": "string", "description": "| Language identifier for the region, e.g., `de` ||" }, "formatDate": { "type": "string", "description": "| Date format ||" }, "formatDatetime": { "type": "string", "description": "| Date and time format ||" }, "formatName": { "type": "string", "description": "| Full name template, e.g., `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Set of localized phrases for the region in the format `code: text`." } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Region parameters (detailed description) ||" }, "title": { "type": "string", "description": "| Region name ||" }, "languageId": { "type": "string", "description": "| Language identifier for the region, e.g., `de` ||" }, "formatDate": { "type": "string", "description": "| Date format ||" }, "formatDatetime": { "type": "string", "description": "| Date and time format ||" }, "formatName": { "type": "string", "description": "| Full name template, e.g., `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Set of localized phrases for the region in the format `code: text`." } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.delete": { "post": { "summary": "Delete Region documentgenerator.region.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.region.delete` removes a custom region by its identifier.", "operationId": "documentgenerator_region_delete", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/region/document-generator-region-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom region." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the custom region." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.get": { "post": { "summary": "Get Region by ID documentgenerator.region.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.region.get` returns region data based on the identifier or code.", "operationId": "documentgenerator_region_get", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/region/document-generator-region-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the custom region or code of a pre-installed region, for example, `de`." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the custom region or code of a pre-installed region, for example, `de`." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.list": { "post": { "summary": "Get the List of Regions documentgenerator.region.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.region.list` returns a list of pre-installed and custom regions.", "operationId": "documentgenerator_region_list", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/region/document-generator-region-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.region.update": { "post": { "summary": "Update Region documentgenerator.region.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.region.update` updates a user-defined region by its identifier.", "operationId": "documentgenerator_region_update", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/region/document-generator-region-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user-defined region." }, "fields": { "type": "object", "description": "| Parameters for updating (detailed description) ||" }, "title": { "type": "string", "description": "| New name of the region ||" }, "languageId": { "type": "string", "description": "| Identifier of the region's language, for example `de` ||" }, "formatDate": { "type": "string", "description": "| Date format ||" }, "formatDatetime": { "type": "string", "description": "| Date and time format ||" }, "formatName": { "type": "string", "description": "| Full name template, for example `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Set of region phrases in the format `code: text`." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user-defined region." }, "fields": { "type": "object", "description": "| Parameters for updating (detailed description) ||" }, "title": { "type": "string", "description": "| New name of the region ||" }, "languageId": { "type": "string", "description": "| Identifier of the region's language, for example `de` ||" }, "formatDate": { "type": "string", "description": "| Date format ||" }, "formatDatetime": { "type": "string", "description": "| Date and time format ||" }, "formatName": { "type": "string", "description": "| Full name template, for example `#LAST_NAME# #NAME# #SECOND_NAME#`." }, "phrases": { "type": "object", "description": "| Set of region phrases in the format `code: text`." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.add": { "post": { "summary": "Add Role documentgenerator.role.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.add` adds a new role.", "operationId": "documentgenerator_role_add", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Role fields (detailed description) ||" }, "name": { "type": "string", "description": "| Role name ||" }, "code": { "type": "string", "description": "| Symbolic role code ||" }, "permissions": { "type": "object", "description": "| Role permissions (detailed description)." }, "SETTINGS": { "type": "object", "description": "| Permissions for settings (detailed description) ||" }, "TEMPLATES": { "type": "object", "description": "| Permissions for templates (detailed description) ||" }, "DOCUMENTS": { "type": "object", "description": "| Permissions for documents (detailed description) ||" }, "MODIFY": { "type": "string", "description": "| Access level to settings. Possible values:" }, "VIEW": { "type": "string", "description": "| Access level for viewing documents. Possible values:" } }, "required": [ "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Role fields (detailed description) ||" }, "name": { "type": "string", "description": "| Role name ||" }, "code": { "type": "string", "description": "| Symbolic role code ||" }, "permissions": { "type": "object", "description": "| Role permissions (detailed description)." }, "SETTINGS": { "type": "object", "description": "| Permissions for settings (detailed description) ||" }, "TEMPLATES": { "type": "object", "description": "| Permissions for templates (detailed description) ||" }, "DOCUMENTS": { "type": "object", "description": "| Permissions for documents (detailed description) ||" }, "MODIFY": { "type": "string", "description": "| Access level to settings. Possible values:" }, "VIEW": { "type": "string", "description": "| Access level for viewing documents. Possible values:" } }, "required": [ "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.delete": { "post": { "summary": "Delete Role documentgenerator.role.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.delete` removes a role by its identifier.", "operationId": "documentgenerator_role_delete", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.fillaccesses": { "post": { "summary": "Bind Users to Roles documentgenerator.role.fillaccesses", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.fillaccesses` completely overwrites the mapping of roles to access codes. The method fully overwrites the settings.", "operationId": "documentgenerator_role_fillaccesses", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-fill-accesses.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "accesses": { "type": "array", "items": {}, "description": "| An array of role bindings to access codes (detailed description) ||" }, "roleId": { "type": "integer", "description": "| Role identifier." }, "accessCode": { "type": "string", "description": "| Access code for a user, group, or department." } }, "required": [ "roleId", "accessCode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "accesses": { "type": "array", "items": {}, "description": "| An array of role bindings to access codes (detailed description) ||" }, "roleId": { "type": "integer", "description": "| Role identifier." }, "accessCode": { "type": "string", "description": "| Access code for a user, group, or department." } }, "required": [ "roleId", "accessCode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.get": { "post": { "summary": "Get Role by ID documentgenerator.role.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.get` returns information about the role and its access permissions.", "operationId": "documentgenerator_role_get", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.list": { "post": { "summary": "Get a List of Roles documentgenerator.role.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.list` returns a list of roles without detailing permissions.", "operationId": "documentgenerator_role_list", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.role.update": { "post": { "summary": "Change Role documentgenerator.role.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.role.update` updates a role by its identifier.", "operationId": "documentgenerator_role_update", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/role/document-generator-role-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." }, "fields": { "type": "object", "description": "| Set of fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| New role name ||" }, "code": { "type": "string", "description": "| New symbolic code for the role ||" }, "permissions": { "type": "object", "description": "| New set of role permissions (detailed description)." }, "SETTINGS": { "type": "object", "description": "| Permissions for settings (detailed description) ||" }, "TEMPLATES": { "type": "object", "description": "| Permissions for templates (detailed description) ||" }, "DOCUMENTS": { "type": "object", "description": "| Permissions for documents (detailed description) ||" }, "MODIFY": { "type": "string", "description": "| Access level to settings. Possible values:" }, "VIEW": { "type": "string", "description": "| Access level to view documents. Possible values:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier." }, "fields": { "type": "object", "description": "| Set of fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| New role name ||" }, "code": { "type": "string", "description": "| New symbolic code for the role ||" }, "permissions": { "type": "object", "description": "| New set of role permissions (detailed description)." }, "SETTINGS": { "type": "object", "description": "| Permissions for settings (detailed description) ||" }, "TEMPLATES": { "type": "object", "description": "| Permissions for templates (detailed description) ||" }, "DOCUMENTS": { "type": "object", "description": "| Permissions for documents (detailed description) ||" }, "MODIFY": { "type": "string", "description": "| Access level to settings. Possible values:" }, "VIEW": { "type": "string", "description": "| Access level to view documents. Possible values:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.add": { "post": { "summary": "Upload Template documentgenerator.template.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.add` adds a new document template.", "operationId": "documentgenerator_template_add", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of template fields (detailed description) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "fileId": { "type": "integer", "description": "| Identifier of the previously uploaded template file from Drive." }, "file": { "type": "string", "description": "| Template file, if it needs to be uploaded. Used instead of the `fileId` parameter." }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator." }, "region": { "type": "string", "description": "| Template region, for example, `de` ||" }, "code": { "type": "string", "description": "| Symbolic code of the template ||" }, "users": { "type": "array", "items": {}, "description": "| Users who will have access to the template." }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity. Possible values:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamps and signatures. Possible values:" }, "sort": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "fields", "name", "fileId", "file", "numeratorId", "region" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Set of template fields (detailed description) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "fileId": { "type": "integer", "description": "| Identifier of the previously uploaded template file from Drive." }, "file": { "type": "string", "description": "| Template file, if it needs to be uploaded. Used instead of the `fileId` parameter." }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator." }, "region": { "type": "string", "description": "| Template region, for example, `de` ||" }, "code": { "type": "string", "description": "| Symbolic code of the template ||" }, "users": { "type": "array", "items": {}, "description": "| Users who will have access to the template." }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity. Possible values:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamps and signatures. Possible values:" }, "sort": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "fields", "name", "fileId", "file", "numeratorId", "region" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.delete": { "post": { "summary": "Delete Template documentgenerator.template.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.delete` removes a template. 1. If there are documents in the system associated with the specified template, the template is marked as deleted to preserve the document associations. You can retrieve a list of templates marked as deleted using the method [documentgenerator.template.list](./document-generator-template-list.md) with a filter for the parameter `isDeleted = \"Y\"`. 2. If the template has no associated documents, the record for the template is completely removed.", "operationId": "documentgenerator_template_delete", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the template." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the template." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.get": { "post": { "summary": "Get Template by ID documentgenerator.template.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.get` returns information about a template by its ID.", "operationId": "documentgenerator_template_get", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Template ID." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Template ID." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.getfields": { "post": { "summary": "Get the List of Fields for documentgenerator.template.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.getfields` returns the detail form of the template fields.", "operationId": "documentgenerator_template_getfields", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the template." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the template." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.list": { "post": { "summary": "Get a List of documentgenerator.template.list Templates", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.list` returns a list of templates based on the filter.", "operationId": "documentgenerator_template_list", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to return. Default is `[\"*\"]`." }, "order": { "type": "object", "description": "| An object for sorting templates in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering templates in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "id": { "type": "integer", "description": "| Template identifier ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity. Possible values:" }, "name": { "type": "string", "description": "| Template name ||" }, "code": { "type": "string", "description": "| Template symbolic code ||" }, "region": { "type": "string", "description": "| Template region ||" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Creation date and time ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Update date and time ||" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Use of stamps and signatures. Possible values:" }, "users": { "type": "array", "items": {}, "description": "| Access codes for the template. Only for `select` ||" }, "providers": { "type": "array", "items": {}, "description": "| Data providers for the template. Only for `select` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to return. Default is `[\"*\"]`." }, "order": { "type": "object", "description": "| An object for sorting templates in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering templates in the format `{\"field_1\":\"value_1\", ... \"field_N\":\"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "id": { "type": "integer", "description": "| Template identifier ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Template activity. Possible values:" }, "name": { "type": "string", "description": "| Template name ||" }, "code": { "type": "string", "description": "| Template symbolic code ||" }, "region": { "type": "string", "description": "| Template region ||" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "createTime": { "type": "string", "format": "date-time", "description": "| Creation date and time ||" }, "updateTime": { "type": "string", "format": "date-time", "description": "| Update date and time ||" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator ||" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Use of stamps and signatures. Possible values:" }, "users": { "type": "array", "items": {}, "description": "| Access codes for the template. Only for `select` ||" }, "providers": { "type": "array", "items": {}, "description": "| Data providers for the template. Only for `select` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/documentgenerator.template.update": { "post": { "summary": "Update Template documentgenerator.template.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `documentgenerator.template.update` updates an existing template.", "operationId": "documentgenerator_template_update", "tags": [ "Document Generator" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/document-generator/templates/document-generator-template-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Template identifier." }, "fields": { "type": "object", "description": "| Template fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "file": { "type": "string", "description": "| New template file. It can be passed in three ways:" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator ||" }, "region": { "type": "string", "description": "| Template region, for example `de` ||" }, "code": { "type": "string", "description": "| Symbolic code of the template ||" }, "users": { "type": "array", "items": {}, "description": "| Users who will have access to the template." }, "providers": { "type": "array", "items": {}, "description": "| List of data providers ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Possible values:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamps and signatures. Possible values:" }, "sort": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Template identifier." }, "fields": { "type": "object", "description": "| Template fields to update (detailed description) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "file": { "type": "string", "description": "| New template file. It can be passed in three ways:" }, "numeratorId": { "type": "integer", "description": "| Identifier of the numerator ||" }, "region": { "type": "string", "description": "| Template region, for example `de` ||" }, "code": { "type": "string", "description": "| Symbolic code of the template ||" }, "users": { "type": "array", "items": {}, "description": "| Users who will have access to the template." }, "providers": { "type": "array", "items": {}, "description": "| List of data providers ||" }, "active": { "type": "string", "maxLength": 1, "description": "| Activity status. Possible values:" }, "withStamps": { "type": "string", "maxLength": 1, "description": "| Include stamps and signatures. Possible values:" }, "sort": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "documentgenerator" ] } ] } }, "/entity.add": { "post": { "summary": "Create a Data Storage entity.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.add` method creates a new data storage for the application. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_add", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/entities/entity-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Access permissions in the format `{\"access_code\":\"permission_level\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| Access permissions in the format `{\"access_code\":\"permission_level\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.delete": { "post": { "summary": "Delete Data Store entity.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.delete` method removes the application's data store. This method only works in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_delete", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/entities/entity-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.get": { "post": { "summary": "Get Storage Parameters or List of Storages entity.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.get` method returns the parameters of the specified storage or a list of all storages of the application. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_get", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/entities/entity-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY": { "type": "string", "description": "| Identifier of the application's data storage. Use the value specified when creating the storage." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY": { "type": "string", "description": "| Identifier of the application's data storage. Use the value specified when creating the storage." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.add": { "post": { "summary": "Add Item to the Storage entity.item.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `entity.item.add` adds an item to the application's data storage. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_item_add", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/entity-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the storage item. ||" }, "PROPERTY_VALUES": { "type": "object", "description": "| Property values of the item in the format `{\"PROPERTY_CODE\": value}`." }, "SECTION": { "type": "integer", "description": "| Identifier of the storage section. ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Start date of the item's activity. ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| End date of the item's activity. ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview image of the item. File format is described in the article How to Upload Files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the item. File format is described in the article How to Upload Files. ||" }, "UF_": { "type": "string", "description": "| Custom fields of the item `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the storage item. ||" }, "PROPERTY_VALUES": { "type": "object", "description": "| Property values of the item in the format `{\"PROPERTY_CODE\": value}`." }, "SECTION": { "type": "integer", "description": "| Identifier of the storage section. ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Start date of the item's activity. ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| End date of the item's activity. ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview image of the item. File format is described in the article How to Upload Files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the item. File format is described in the article How to Upload Files. ||" }, "UF_": { "type": "string", "description": "| Custom fields of the item `UF_*`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.delete": { "post": { "summary": "Delete Entity Storage Method: entity.item.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.item.delete` method removes an item from the application's data storage. This method works only within the context of an [application](../../../settings/app-installation/index.md).", "operationId": "entity_item_delete", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/entity-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.get": { "post": { "summary": "Get a List of Storage Items: entity.item.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.item.get` method retrieves a list of items from the application's data storage. This method works only in the context of an [application](../../../settings/app-installation/index.md).", "operationId": "entity_item_get", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/entity-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Object format:" }, "FILTER": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Object format:" }, "FILTER": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.add": { "post": { "summary": "Add Property to Data Storage Elements entity.item.property.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `entity.item.property.add` adds a property to the elements of the application's data storage. The method works only in the context of the [application](../../../../settings/app-installation/index.md).", "operationId": "entity_item_property_add", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/properties/entity-item-property-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the property ||" }, "TYPE": { "type": "string", "description": "| Type of the property:" }, "SORT": { "type": "integer", "description": "| Sorting index of the property ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the property ||" }, "TYPE": { "type": "string", "description": "| Type of the property:" }, "SORT": { "type": "integer", "description": "| Sorting index of the property ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.delete": { "post": { "summary": "Delete Property of Storage Elements entity.item.property.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `entity.item.property.delete` removes a property from the application's data storage elements. The method works only in the context of the [application](../../../../settings/app-installation/index.md).", "operationId": "entity_item_property_delete", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/properties/entity-item-property-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.get": { "post": { "summary": "Get Properties of Storage Elements entity.item.property.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `entity.item.property.get` returns the properties of the application's data storage elements. The method works only in the context of the [application](../../../../settings/app-installation/index.md).", "operationId": "entity_item_property_get", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/properties/entity-item-property-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY": { "type": "string", "description": "| Property code." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY": { "type": "string", "description": "| Property code." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.property.update": { "post": { "summary": "Update Property of Storage Elements entity.item.property.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `entity.item.property.update` modifies the property of elements in the application's data storage. The method works only in the context of the [application](../../../../settings/app-installation/index.md).", "operationId": "entity_item_property_update", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/properties/entity-item-property-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PROPERTY_NEW": { "type": "string", "description": "| New property code." }, "NAME": { "type": "string", "description": "| New property name. ||" }, "TYPE": { "type": "string", "description": "| New property type:" }, "SORT": { "type": "integer", "description": "| Property sort index. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PROPERTY_NEW": { "type": "string", "description": "| New property code." }, "NAME": { "type": "string", "description": "| New property name. ||" }, "TYPE": { "type": "string", "description": "| New property type:" }, "SORT": { "type": "integer", "description": "| Property sort index. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.item.update": { "post": { "summary": "Update Entity Storage entity.item.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_item_update", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/items/entity-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| New name of the storage item ||" }, "PROPERTY_VALUES": { "type": "object", "description": "| Property values of the item in the format `{\"PROPERTY_CODE\": value}`." }, "SECTION": { "type": "integer", "description": "| Identifier of the storage section ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Start date of the item's activity ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| End date of the item's activity ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview image of the item. File format is described in the article How to Upload Files." }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the item. File format is described in the article How to Upload Files." }, "UF_": { "type": "string", "description": "| Custom fields of the item `UF_*`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| New name of the storage item ||" }, "PROPERTY_VALUES": { "type": "object", "description": "| Property values of the item in the format `{\"PROPERTY_CODE\": value}`." }, "SECTION": { "type": "integer", "description": "| Identifier of the storage section ||" }, "DATE_ACTIVE_FROM": { "type": "string", "format": "date-time", "description": "| Start date of the item's activity ||" }, "DATE_ACTIVE_TO": { "type": "string", "format": "date-time", "description": "| End date of the item's activity ||" }, "PREVIEW_PICTURE": { "type": "string", "description": "| Preview image of the item. File format is described in the article How to Upload Files." }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the item. File format is described in the article How to Upload Files." }, "UF_": { "type": "string", "description": "| Custom fields of the item `UF_*`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.rights": { "post": { "summary": "Get or Modify Access Permissions for entity.rights", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.rights` method retrieves the current set of access permissions for the application's data storage or modifies it. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_rights", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/entities/entity-rights.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| A new set of permissions in the format `{\"access_code\":\"access_level\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "object", "description": "| A new set of permissions in the format `{\"access_code\":\"access_level\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.add": { "post": { "summary": "Add Section to the entity.section.add Storage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.section.add` method adds a section to the application's data storage. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_section_add", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/sections/entity-section-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Identifier of the parent section. ||" }, "ACTIVE": { "type": "string", "description": "| Section activity flag:" }, "SORT": { "type": "integer", "description": "| Section sorting index. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the section. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the section. ||" }, "PICTURE": { "type": "string", "description": "| Section image. File format — as described in How to upload files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the section. File format — as described in How to upload files. ||" }, "UF_": { "type": "object", "description": "| Custom fields of the section `UF_*` in the format `{\"UF_CODE\": value}` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SECTION": { "type": "integer", "description": "| Identifier of the parent section. ||" }, "ACTIVE": { "type": "string", "description": "| Section activity flag:" }, "SORT": { "type": "integer", "description": "| Section sorting index. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the section. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the section. ||" }, "PICTURE": { "type": "string", "description": "| Section image. File format — as described in How to upload files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the section. File format — as described in How to upload files. ||" }, "UF_": { "type": "object", "description": "| Custom fields of the section `UF_*` in the format `{\"UF_CODE\": value}` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.delete": { "post": { "summary": "Delete the entity.section.delete method", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.section.delete` method removes a section from the application's data storage. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_section_delete", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/sections/entity-section-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.get": { "post": { "summary": "Get a List of Sections with entity.section.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. The `entity.section.get` method retrieves a list of sections from the application's data storage. The method works only in the context of an [application](../../../settings/app-installation/index.md).", "operationId": "entity_section_get", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/sections/entity-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Object format:" }, "FILTER": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SORT": { "type": "object", "description": "| Object format:" }, "FILTER": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Pagination parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.section.update": { "post": { "summary": "Update the entity.section.update method", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.section.update` method updates a section of the application's data storage. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_section_update", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/sections/entity-section-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the section. ||" }, "SECTION": { "type": "integer", "description": "| Identifier of the parent section. ||" }, "ACTIVE": { "type": "string", "description": "| Active flag for the section:" }, "SORT": { "type": "integer", "description": "| Sorting index of the section. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the section. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the section. ||" }, "PICTURE": { "type": "string", "description": "| Image of the section. File format — see the article How to upload files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the section. File format — see the article How to upload files. ||" }, "UF_": { "type": "object", "description": "| Custom fields of the section `UF_*` in the format `{\"UF_CODE\": value}` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the section. ||" }, "SECTION": { "type": "integer", "description": "| Identifier of the parent section. ||" }, "ACTIVE": { "type": "string", "description": "| Active flag for the section:" }, "SORT": { "type": "integer", "description": "| Sorting index of the section. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the section. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the section. ||" }, "PICTURE": { "type": "string", "description": "| Image of the section. File format — see the article How to upload files. ||" }, "DETAIL_PICTURE": { "type": "string", "description": "| Detailed image of the section. File format — see the article How to upload files. ||" }, "UF_": { "type": "object", "description": "| Custom fields of the section `UF_*` in the format `{\"UF_CODE\": value}` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/entity.update": { "post": { "summary": "Change Parameters of entity.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `entity.update` method updates the parameters of the application's data storage. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "entity_update", "tags": [ "Data Storage" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/entity/entities/entity-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| New name for the storage. ||" }, "ENTITY_NEW": { "type": "string", "description": "| New identifier for the storage." }, "ACCESS": { "type": "object", "description": "| New set of access permissions in the format `{\"access_code\":\"permission_level\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| New name for the storage. ||" }, "ENTITY_NEW": { "type": "string", "description": "| New identifier for the storage." }, "ACCESS": { "type": "object", "description": "| New set of access permissions in the format `{\"access_code\":\"permission_level\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "entity" ] } ] } }, "/event.bind": { "post": { "summary": "Register a new event handler event.bind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `event.bind` registers a new event handler. The method works only in the context of [application](../../settings/app-installation/index.md) authorization. It can operate both under a user with portal administration rights and under a regular user. The method for a user without administrator rights is available with limitations: 1. Offline events are not available; attempting to set them will raise an exception.", "operationId": "event_bind", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-bind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Event name ||" }, "handler": { "type": "string", "description": "| Link to the event handler ||" }, "auth_type": { "type": "integer", "description": "| User ID under which the event handler is authorized. By default, the authorization of the user whose actions triggered the event will be used ||" }, "event_type": { "type": "string", "description": "| Values: `online\\|offline`. By default, `event_type=online`, and the method's behavior does not change. If `event_type=offline` is called, the method works with offline events ||" }, "auth_connector": { "type": "string", "description": "| Source key. This parameter is intended for offline events. It allows excluding false event triggers ||" }, "options": { "type": "string", "description": "| Additional settings for the registered event, if any ||" } }, "required": [ "event", "handler" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Event name ||" }, "handler": { "type": "string", "description": "| Link to the event handler ||" }, "auth_type": { "type": "integer", "description": "| User ID under which the event handler is authorized. By default, the authorization of the user whose actions triggered the event will be used ||" }, "event_type": { "type": "string", "description": "| Values: `online\\|offline`. By default, `event_type=online`, and the method's behavior does not change. If `event_type=offline` is called, the method works with offline events ||" }, "auth_connector": { "type": "string", "description": "| Source key. This parameter is intended for offline events. It allows excluding false event triggers ||" }, "options": { "type": "string", "description": "| Additional settings for the registered event, if any ||" } }, "required": [ "event", "handler" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.get": { "post": { "summary": "Get a List of Registered Event Handlers event.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `event.get` method allows you to retrieve a list of registered event handlers. The method works only in the context of authorizing the [application](../../settings/app-installation/index.md). No parameters.", "operationId": "event_get", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.offline.clear": { "post": { "summary": "Clear records in the offline event queue event.offline.clear", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `event.offline.clear` clears records in the offline event queue. The availability of offline events can be checked through the method [feature.get](../common/system/feature-get.md). The method works only in the context of application authorization [application](../../settings/app-installation/index.md).", "operationId": "event_offline_clear", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-offline-clear.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Identifier of the process that handles the records ||" }, "id": { "type": "array", "items": {}, "description": "| Array of identifiers of the records to be cleared. By default, all records marked with the provided `process_id` will be cleared ||" }, "message_id": { "type": "array", "items": {}, "description": "| Array of values of the `MESSAGE_ID` field of the records to be cleared. Ignored if the `id` parameter is specified. By default, all records marked with the provided `process_id` will be cleared ||" } }, "required": [ "process_id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Identifier of the process that handles the records ||" }, "id": { "type": "array", "items": {}, "description": "| Array of identifiers of the records to be cleared. By default, all records marked with the provided `process_id` will be cleared ||" }, "message_id": { "type": "array", "items": {}, "description": "| Array of values of the `MESSAGE_ID` field of the records to be cleared. Ignored if the `id` parameter is specified. By default, all records marked with the provided `process_id` will be cleared ||" } }, "required": [ "process_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.offline.error": { "post": { "summary": "Register Errors for Processing Offline Events event.offline.error", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `event.offline.error` saves a record in the database with an error mark when using offline events. The availability of offline events can be checked through the method [feature.get](../common/system/feature-get.md). The method works only in the context of authorizing the [application](../../settings/app-installation/index.md).", "operationId": "event_offline_error", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-offline-error.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Identifier of the process that is handling the records ||" }, "message_id": { "type": "array", "items": {}, "description": "| Array of values for the `MESSAGE_ID` field of the records to be marked as erroneous ||" } }, "required": [ "process_id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "process_id": { "type": "string", "description": "| Identifier of the process that is handling the records ||" }, "message_id": { "type": "array", "items": {}, "description": "| Array of values for the `MESSAGE_ID` field of the records to be marked as erroneous ||" } }, "required": [ "process_id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.offline.get": { "post": { "summary": "Get a List of Offline Events with event.offline.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `event.offline.get` returns the first queued offline events to the application according to the filter settings. The availability of offline events can be checked using the [feature.get](../common/system/feature-get.md) method. This method works only in the context of [application](../../settings/app-installation/index.md) authorization.", "operationId": "event_offline_get", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-offline-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Record filter. By default, all records are returned without filtering. Filtering is supported by fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID` with standard operations like `=`, `>`, `<`, `<=`, and so on." }, "order": { "type": "array", "items": {}, "description": "| Record sorting. Sorting is supported by the same fields as in the filter, and an array of the form `[field=>ASC|DESC]` is accepted. By default — [TIMESTAMP_X:ASC] ||" }, "limit": { "type": "integer", "description": "| Number of records to select. Default is 50 ||" }, "clear": { "type": "integer", "description": "| Values: `0|1` — whether to delete the selected records. Default is `1` ||" }, "process_id": { "type": "string", "description": "| Process identifier. Used if you need to re-select any unprocessed records from the current process ||" }, "auth_connector": { "type": "string", "description": "| Source key. Used if the `auth_connector` value was specified in the event.bind method ||" }, "error": { "type": "integer", "description": "| Values: `0|1` — whether to return erroneous records. Default is `0` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Record filter. By default, all records are returned without filtering. Filtering is supported by fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID` with standard operations like `=`, `>`, `<`, `<=`, and so on." }, "order": { "type": "array", "items": {}, "description": "| Record sorting. Sorting is supported by the same fields as in the filter, and an array of the form `[field=>ASC|DESC]` is accepted. By default — [TIMESTAMP_X:ASC] ||" }, "limit": { "type": "integer", "description": "| Number of records to select. Default is 50 ||" }, "clear": { "type": "integer", "description": "| Values: `0|1` — whether to delete the selected records. Default is `1` ||" }, "process_id": { "type": "string", "description": "| Process identifier. Used if you need to re-select any unprocessed records from the current process ||" }, "auth_connector": { "type": "string", "description": "| Source key. Used if the `auth_connector` value was specified in the event.bind method ||" }, "error": { "type": "integer", "description": "| Values: `0|1` — whether to return erroneous records. Default is `0` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.offline.list": { "post": { "summary": "Get a list of offline events event.offline.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `event.offline.list` is used to read the current queue without making changes to its state, unlike [event.offline.get](./event-offline-get.md). The availability of offline events can be checked through the [feature.get](../common/system/feature-get.md) method. The method works only in the context of application authorization [application](../../settings/app-installation/index.md).", "operationId": "event_offline_list", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-offline-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Record filter. By default, all records are returned without filtering. Filtering is supported by the fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`, `PROCESS_ID`, `ERROR` with standard operations like `=`, `>`, `<`, `<=`, and so on ||" }, "order": { "type": "array", "items": {}, "description": "| Record sorting. Sorting is supported by the same fields as in the filter, and an array of the form `[field=>ASC|DESC]` is accepted. By default — `[ID:ASC]` ||" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "array", "items": {}, "description": "| Record filter. By default, all records are returned without filtering. Filtering is supported by the fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`, `PROCESS_ID`, `ERROR` with standard operations like `=`, `>`, `<`, `<=`, and so on ||" }, "order": { "type": "array", "items": {}, "description": "| Record sorting. Sorting is supported by the same fields as in the filter, and an array of the form `[field=>ASC|DESC]` is accepted. By default — `[ID:ASC]` ||" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/event.unbind": { "post": { "summary": "Unbind Registered Event Handler event.unbind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `event.unbind` method cancels a registered event handler. This method works only in the context of [application](../../settings/app-installation/index.md) authorization and only when authorized under a user with administrative rights to the account.", "operationId": "event_unbind", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/event-unbind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Event name ||" }, "handler": { "type": "string", "description": "| Link to the event handler ||" }, "auth_type": { "type": "integer", "description": "| User identifier under which the event handler is authorized." }, "event_type": { "type": "string", "description": "| Values: `online\\|offline`. By default, `event_type=online`, and the method's behavior remains unchanged. If `event_type=offline` is called, the method works with offline events ||" } }, "required": [ "event", "handler" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "| Event name ||" }, "handler": { "type": "string", "description": "| Link to the event handler ||" }, "auth_type": { "type": "integer", "description": "| User identifier under which the event handler is authorized." }, "event_type": { "type": "string", "description": "| Values: `online\\|offline`. By default, `event_type=online`, and the method's behavior remains unchanged. If `event_type=offline` is called, the method works with offline events ||" } }, "required": [ "event", "handler" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/events": { "post": { "summary": "Get a list of available events", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `events` method returns a comprehensive list of available events. The method works only in the context of authorizing the [application](../../settings/app-installation/index.md).", "operationId": "events", "tags": [ "Events" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/events/events.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| The method will return events belonging to the specified permission ||" }, "FULL": { "type": "boolean", "description": "| The method will return the complete list of events. This parameter will be ignored if the `SCOPE` parameter is provided ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| The method will return events belonging to the specified permission ||" }, "FULL": { "type": "boolean", "description": "| The method will return the complete list of events. This parameter will be ignored if the `SCOPE` parameter is provided ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/feature.access": { "post": { "summary": "Check the access permissions of the current user sonet_group.feature.access", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.feature.access` checks whether the current user has access to operations within the group or project functionality.", "operationId": "feature_access", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/sonet-group-feature-access.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the group or project." }, "FEATURE": { "type": "string", "description": "| Symbolic code of the group functionality." }, "OPERATION": { "type": "string", "description": "| Symbolic code of the operation within the functionality." } }, "required": [ "GROUP_ID", "FEATURE", "OPERATION" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the group or project." }, "FEATURE": { "type": "string", "description": "| Symbolic code of the group functionality." }, "OPERATION": { "type": "string", "description": "| Symbolic code of the operation within the functionality." } }, "required": [ "GROUP_ID", "FEATURE", "OPERATION" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/feature.get": { "post": { "summary": "Get information about feature availability on the account feature.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `feature.get` returns information about the availability of features on a specific account.", "operationId": "feature_get", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/feature-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Available keys:" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Available keys:" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/im.chat.add": { "post": { "summary": "Create Chat im.chat.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.add` creates a new chat.", "operationId": "im_chat_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-chat-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USERS": { "type": "array", "items": {}, "description": "| An array of user IDs to be added to the chat." }, "TYPE": { "type": "string", "description": "| Type of chat:" }, "TITLE": { "type": "string", "description": "| Title of the chat." }, "DESCRIPTION": { "type": "string", "description": "| Description of the chat ||" }, "COLOR": { "type": "string", "description": "| Color of the chat. Possible values:" }, "MESSAGE": { "type": "string", "description": "| The first message in the chat ||" }, "AVATAR": { "type": "string", "description": "| Avatar of the chat in base64 string format." }, "ENTITY_TYPE": { "type": "string", "description": "| Type of object to link the chat with external context." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." }, "COPILOT_MAIN_ROLE": { "type": "string", "description": "| Code of the main role for BitrixGPT." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USERS": { "type": "array", "items": {}, "description": "| An array of user IDs to be added to the chat." }, "TYPE": { "type": "string", "description": "| Type of chat:" }, "TITLE": { "type": "string", "description": "| Title of the chat." }, "DESCRIPTION": { "type": "string", "description": "| Description of the chat ||" }, "COLOR": { "type": "string", "description": "| Color of the chat. Possible values:" }, "MESSAGE": { "type": "string", "description": "| The first message in the chat ||" }, "AVATAR": { "type": "string", "description": "| Avatar of the chat in base64 string format." }, "ENTITY_TYPE": { "type": "string", "description": "| Type of object to link the chat with external context." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." }, "COPILOT_MAIN_ROLE": { "type": "string", "description": "| Code of the main role for BitrixGPT." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.get": { "post": { "summary": "Get Chat ID im.chat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.get` retrieves the chat ID.", "operationId": "im_chat_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-chat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| The type of object for linking the chat to an external context. Passed as a string." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| The type of object for linking the chat to an external context. Passed as a string." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.leave": { "post": { "summary": "Leave Chat im.chat.leave", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.leave` removes the current user from the chat.", "operationId": "im_chat_leave", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-users/im-chat-leave.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.mute": { "post": { "summary": "Disable Notifications from Chat im.chat.mute", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.mute` disables or enables notifications in the specified chat.", "operationId": "im_chat_mute", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/special-operations/im-chat-mute.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat. You can obtain the identifier using the im.chat.get method ||" }, "DIALOG_ID": { "type": "string", "description": "| The chat identifier in the format:" }, "MUTE": { "type": "string", "description": "| Notification control:" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat. You can obtain the identifier using the im.chat.get method ||" }, "DIALOG_ID": { "type": "string", "description": "| The chat identifier in the format:" }, "MUTE": { "type": "string", "description": "| Notification control:" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.setOwner": { "post": { "summary": "Change Chat Owner im.chat.setOwner", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.setOwner` changes the owner of the chat.", "operationId": "im_chat_setOwner", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-update/im-chat-set-owner.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the new chat owner." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the new chat owner." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateAvatar": { "post": { "summary": "Update Chat Avatar im.chat.updateAvatar", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateAvatar` updates the chat avatar.", "operationId": "im_chat_updateAvatar", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-update/im-chat-update-avatar.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "AVATAR": { "type": "string", "description": "| Image in Base64 format." } }, "required": [ "CHAT_ID", "AVATAR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "AVATAR": { "type": "string", "description": "| Image in Base64 format." } }, "required": [ "CHAT_ID", "AVATAR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateColor": { "post": { "summary": "Change Chat Color im.chat.updateColor", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateColor` updates the chat color for the mobile application.", "operationId": "im_chat_updateColor", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-update/im-chat-update-color.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "COLOR": { "type": "string", "description": "| Chat color for the mobile application. Possible values:" } }, "required": [ "CHAT_ID", "COLOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "COLOR": { "type": "string", "description": "| Chat color for the mobile application. Possible values:" } }, "required": [ "CHAT_ID", "COLOR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.updateTitle": { "post": { "summary": "Update Chat Title im.chat.updateTitle", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateTitle` updates the chat title.", "operationId": "im_chat_updateTitle", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-update/im-chat-update-title.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Chat identifier." }, "TITLE": { "type": "string", "description": "| Chat title." } }, "required": [ "CHAT_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Chat identifier." }, "TITLE": { "type": "string", "description": "| Chat title." } }, "required": [ "CHAT_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.add": { "post": { "summary": "Invite Participants to Chat im.chat.user.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.add` adds users to a chat.", "operationId": "im_chat_user_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-users/im-chat-user-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USERS": { "type": "array", "items": {}, "description": "| Array of user identifiers to be added to the chat." }, "HIDE_HISTORY": { "type": "string", "description": "| Hide chat history for added users:" } }, "required": [ "CHAT_ID", "USERS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USERS": { "type": "array", "items": {}, "description": "| Array of user identifiers to be added to the chat." }, "HIDE_HISTORY": { "type": "string", "description": "| Hide chat history for added users:" } }, "required": [ "CHAT_ID", "USERS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.delete": { "post": { "summary": "Exclude Participants from Chat im.chat.user.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.delete` removes a user from the chat.", "operationId": "im_chat_user_delete", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-users/im-chat-user-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user to be excluded from the chat." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user to be excluded from the chat." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.chat.user.list": { "post": { "summary": "Get Chat Participant IDs im.chat.user.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.list` returns a list of chat participant IDs.", "operationId": "im_chat_user_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-users/im-chat-user-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.counters.get": { "post": { "summary": "Get Counters im.counters.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.counters.get` retrieves the counters for unread messages and notifications for the current user.", "operationId": "im_counters_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-counters-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.colleagues.list": { "post": { "summary": "Get the List of Colleagues for the Current User im.department.colleagues.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.colleagues.list` retrieves the list of colleagues for the current user. For a manager, the method will return a list of subordinates and all supervisors.", "operationId": "im_department_colleagues_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/departments/im-department-colleagues-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_DATA": { "type": "string", "description": "| Return detailed user data." }, "OFFSET": { "type": "integer", "description": "| Offset for user selection ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_DATA": { "type": "string", "description": "| Return detailed user data." }, "OFFSET": { "type": "integer", "description": "| Offset for user selection ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.employees.get": { "post": { "summary": "Get a List of Employees from Departments im.department.employees.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.employees.get` retrieves a list of employees from the specified departments.", "operationId": "im_department_employees_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/departments/im-department-employees-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department IDs. You can pass a string with a JSON array of IDs." }, "USER_DATA": { "type": "string", "description": "| Return detailed user data." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department IDs. You can pass a string with a JSON array of IDs." }, "USER_DATA": { "type": "string", "description": "| Return detailed user data." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.get": { "post": { "summary": "Get Information About the Department im.department.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.get` retrieves data about departments by their `ID` identifiers.", "operationId": "im_department_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/departments/im-department-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department identifiers. You can pass a string with a JSON array of identifiers." }, "USER_DATA": { "type": "string", "description": "| Return data about the department head." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department identifiers. You can pass a string with a JSON array of identifiers." }, "USER_DATA": { "type": "string", "description": "| Return data about the department head." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.department.managers.get": { "post": { "summary": "Get a List of Department Managers im.department.managers.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.managers.get` retrieves a list of managers for the specified departments.", "operationId": "im_department_managers_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/departments/im-department-managers-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department identifiers. You can pass a string with a JSON array of identifiers." }, "USER_DATA": { "type": "string", "description": "| Return detailed user data." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {}, "description": "| An array of department identifiers. You can pass a string with a JSON array of identifiers." }, "USER_DATA": { "type": "string", "description": "| Return detailed user data." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.get": { "post": { "summary": "Get Chat Data im.dialog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.get` retrieves information about a chat.", "operationId": "im_dialog_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-dialog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Chat identifier in the format:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Chat identifier in the format:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.messages.get": { "post": { "summary": "Get the List of Recent Messages im.dialog.messages.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.messages.get` retrieves messages from the specified dialog, including system messages. It does not support standard pagination due to the potential large volume of data. Messages can only be retrieved without participating in the chat for Open Line chats via the method [imopenlines.session.history.get](../../imopenlines/openlines/sessions/imopenlines-session-history-get.md).", "operationId": "im_dialog_messages_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-dialog-messages-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the message older than which messages need to be loaded. The method will return messages with identifiers less than the specified one. ||" }, "FIRST_ID": { "type": "integer", "description": "| Identifier of the message newer than which messages need to be loaded. The method will return messages with identifiers greater than the specified one." }, "LIMIT": { "type": "integer", "description": "| Limit on the number of messages in the response. If `LAST_ID` and `FIRST_ID` are not provided, the method will return the last N messages of the dialog specified in `LIMIT`." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the message older than which messages need to be loaded. The method will return messages with identifiers less than the specified one. ||" }, "FIRST_ID": { "type": "integer", "description": "| Identifier of the message newer than which messages need to be loaded. The method will return messages with identifiers greater than the specified one." }, "LIMIT": { "type": "integer", "description": "| Limit on the number of messages in the response. If `LAST_ID` and `FIRST_ID` are not provided, the method will return the last N messages of the dialog specified in `LIMIT`." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.messages.search": { "post": { "summary": "Find Message in Chat im.dialog.messages.search", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.messages.search` performs a search for messages in the chat.", "operationId": "im_dialog_messages_search", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-dialog-messages-search.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SEARCH_MESSAGE": { "type": "string", "description": "| Search string for the message text." }, "DATE_FROM": { "type": "string", "format": "date-time", "description": "| Start of the search period in ISO 8601 format (RFC3339) ||" }, "DATE_TO": { "type": "string", "format": "date-time", "description": "| End of the search period in ISO 8601 format (RFC3339) ||" }, "DATE": { "type": "string", "format": "date-time", "description": "| Search for messages on a specific date in ISO 8601 format (RFC3339)." }, "ORDER": { "type": "object", "description": "| Sorting parameters." }, "LIMIT": { "type": "integer", "description": "| Number of messages returned." }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last message from the previous selection for pagination ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SEARCH_MESSAGE": { "type": "string", "description": "| Search string for the message text." }, "DATE_FROM": { "type": "string", "format": "date-time", "description": "| Start of the search period in ISO 8601 format (RFC3339) ||" }, "DATE_TO": { "type": "string", "format": "date-time", "description": "| End of the search period in ISO 8601 format (RFC3339) ||" }, "DATE": { "type": "string", "format": "date-time", "description": "| Search for messages on a specific date in ISO 8601 format (RFC3339)." }, "ORDER": { "type": "object", "description": "| Sorting parameters." }, "LIMIT": { "type": "integer", "description": "| Number of messages returned." }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last message from the previous selection for pagination ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.read": { "post": { "summary": "Set the \"read\" flag for messages im.dialog.read", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.read` sets the \"read\" flag for dialog messages up to and including the specified message.", "operationId": "im_dialog_read", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-dialog-read.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the last read message. If not provided, the method sets the read flag for all unread messages ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the last read message. If not provided, the method sets the read flag for all unread messages ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.read.all": { "post": { "summary": "Set the \"read\" flag for all chats im.dialog.read.all", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.read.all` sets the \"read\" flag for all chats of the current user.", "operationId": "im_dialog_read_all", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/special-operations/im-dialog-read-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.unread": { "post": { "summary": "Set the \"unread\" flag for messages im.dialog.unread", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.unread` sets the \"unread\" flag for messages in a dialog starting from the specified message.", "operationId": "im_dialog_unread", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-dialog-unread.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the first unread message ||" } }, "required": [ "DIALOG_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the first unread message ||" } }, "required": [ "DIALOG_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.users.list": { "post": { "summary": "Get the List of Participants im.dialog.users.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.users.list` returns detailed information about the participants in the dialog with pagination support.", "operationId": "im_dialog_users_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/chat-users/im-dialog-users-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "SKIP_EXTERNAL": { "type": "string", "description": "| Exclude system users:" }, "SKIP_EXTERNAL_EXCEPT_TYPES": { "type": "string", "description": "| A list of types of system users to keep in the selection, separated by commas." }, "LIMIT": { "type": "integer", "description": "| Number of items per page. Default: `50`. Maximum value: `200` ||" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last user from the selection `LIMIT`." }, "OFFSET": { "type": "integer", "description": "| Offset for pagination. Default: `0` ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "SKIP_EXTERNAL": { "type": "string", "description": "| Exclude system users:" }, "SKIP_EXTERNAL_EXCEPT_TYPES": { "type": "string", "description": "| A list of types of system users to keep in the selection, separated by commas." }, "LIMIT": { "type": "integer", "description": "| Number of items per page. Default: `50`. Maximum value: `200` ||" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last user from the selection `LIMIT`." }, "OFFSET": { "type": "integer", "description": "| Offset for pagination. Default: `0` ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.dialog.writing": { "post": { "summary": "Send \"User is typing\" indicator im.dialog.writing", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.writing` sends a \"User is typing\" indicator to the chat.", "operationId": "im_dialog_writing", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-dialog-writing.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.commit": { "post": { "summary": "Add File to Chat im.disk.file.commit", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.commit` adds a file to a chat. To add a file, specify: - one of the chat identifier parameters — `CHAT_ID` or `DIALOG_ID`", "operationId": "im_disk_file_commit", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/files/im-disk-file-commit.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format:" }, "FILE_ID": { "type": "integer", "description": "| Identifier of the file on Drive. An array can be passed." }, "UPLOAD_ID": { "type": "integer", "description": "| Identifier of the file on Drive. An array can be passed." }, "MESSAGE": { "type": "string", "description": "| Text message with the file ||" }, "SILENT_MODE": { "type": "string", "description": "| Parameter for Open Channels chat" }, "AS_FILE": { "type": "string", "description": "| Send as a file. Only for `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": "| Identifier of the chat." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format:" }, "FILE_ID": { "type": "integer", "description": "| Identifier of the file on Drive. An array can be passed." }, "UPLOAD_ID": { "type": "integer", "description": "| Identifier of the file on Drive. An array can be passed." }, "MESSAGE": { "type": "string", "description": "| Text message with the file ||" }, "SILENT_MODE": { "type": "string", "description": "| Parameter for Open Channels chat" }, "AS_FILE": { "type": "string", "description": "| Send as a file. Only for `UPLOAD_ID`." } }, "required": [ "CHAT_ID", "DIALOG_ID", "FILE_ID", "UPLOAD_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.delete": { "post": { "summary": "Delete File from Chat Folder im.disk.file.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.delete` removes a file from the chat folder. Only the user—who is a participant in the chat and sent the file—can delete it. Other chat participants cannot delete the file. After deletion, the text *Message deleted* is displayed in the chat instead of the file.", "operationId": "im_disk_file_delete", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/files/im-disk-file-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat ||" }, "FILE_ID": { "type": "integer", "description": "| Identifier of the file ||" } }, "required": [ "CHAT_ID", "FILE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat ||" }, "FILE_ID": { "type": "integer", "description": "| Identifier of the file ||" } }, "required": [ "CHAT_ID", "FILE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.file.save": { "post": { "summary": "Save File to Your Drive im.disk.file.save", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.save` saves a file from the chat to the user's personal Drive. The file is saved in the *Saved Files* folder. If the folder does not exist, the system will create it automatically.", "operationId": "im_disk_file_save", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/files/im-disk-file-save.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILE_ID": { "type": "integer", "description": "| File identifier ||" } }, "required": [ "FILE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILE_ID": { "type": "integer", "description": "| File identifier ||" } }, "required": [ "FILE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.disk.folder.get": { "post": { "summary": "Get Chat File Storage Folder im.disk.folder.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.folder.get` retrieves the identifier of the folder where chat files are stored. The identifier from the response can be used in Drive methods: - [disk.folder.uploadfile](../../disk/folder/disk-folder-upload-file.md) to upload a file to the chat folder", "operationId": "im_disk_folder_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/files/im-disk-folder-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat. Required if `DIALOG_ID` is not provided ||" }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format `chatXXX`, where `XXX` is the identifier. Required if `CHAT_ID` is not provided ||" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat. Required if `DIALOG_ID` is not provided ||" }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format `chatXXX`, where `XXX` is the identifier. Required if `CHAT_ID` is not provided ||" } }, "required": [ "CHAT_ID", "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.add": { "post": { "summary": "Send Message im.message.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.add` sends a message to a chat.", "operationId": "im_message_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE": { "type": "string", "description": "| The text of the message. Required if `ATTACH` is not provided." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Indicator of a system message." }, "URL_PREVIEW": { "type": "string", "description": "| Conversion of links into rich links." }, "REPLY_ID": { "type": "integer", "description": "| Identifier of the message to which the reply is sent. The message for the reply must be in the same chat." } }, "required": [ "DIALOG_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "MESSAGE": { "type": "string", "description": "| The text of the message. Required if `ATTACH` is not provided." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Indicator of a system message." }, "URL_PREVIEW": { "type": "string", "description": "| Conversion of links into rich links." }, "REPLY_ID": { "type": "integer", "description": "| Identifier of the message to which the reply is sent. The message for the reply must be in the same chat." } }, "required": [ "DIALOG_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.command": { "post": { "summary": "Execute the chat-bot command im.message.command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.command` executes a chat-bot command in the context of a message.", "operationId": "im_message_command", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-command.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message in the context of which the command is executed." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the bot." }, "COMMAND": { "type": "string", "description": "| The bot command." }, "COMMAND_PARAMS": { "type": "string", "description": "| Command parameter ||" } }, "required": [ "MESSAGE_ID", "BOT_ID", "COMMAND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message in the context of which the command is executed." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the bot." }, "COMMAND": { "type": "string", "description": "| The bot command." }, "COMMAND_PARAMS": { "type": "string", "description": "| Command parameter ||" } }, "required": [ "MESSAGE_ID", "BOT_ID", "COMMAND" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.delete": { "post": { "summary": "Delete Message im.message.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.delete` removes a message.", "operationId": "im_message_delete", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.like": { "post": { "summary": "Change Status to \"Like\" im.message.like", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.like` sets or removes the \"Like\" mark for a message.", "operationId": "im_message_like", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-like.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "ACTION": { "type": "string", "description": "| Action for reacting to the message." } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "ACTION": { "type": "string", "description": "| Action for reacting to the message." } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.share": { "post": { "summary": "Create an Object Based on the Message im.message.share", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.share` creates an object based on a message.", "operationId": "im_message_share", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-share.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "TYPE": { "type": "string", "description": "| Type of the object being created." } }, "required": [ "MESSAGE_ID", "DIALOG_ID", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "TYPE": { "type": "string", "description": "| Type of the object being created." } }, "required": [ "MESSAGE_ID", "DIALOG_ID", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.message.update": { "post": { "summary": "Update Message im.message.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.update` modifies the text and parameters of an already sent message.", "operationId": "im_message_update", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/messages/im-message-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "MESSAGE": { "type": "string", "description": "| New text of the message. If an empty value is provided, the message will be deleted." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Conversion of links into rich links." }, "IS_EDITED": { "type": "string", "description": "| Flag for marking \"edited\":" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message." }, "MESSAGE": { "type": "string", "description": "| New text of the message. If an empty value is provided, the message will be deleted." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Conversion of links into rich links." }, "IS_EDITED": { "type": "string", "description": "| Flag for marking \"edited\":" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify": { "post": { "summary": "Send Notification im.notify", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `im.notify` method sends a notification to a user. The method is only available when called through the application.", "operationId": "im_notify", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user receiving the notification." }, "TYPE": { "type": "string", "description": "| The type of notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the ends of the string before sending. ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass it with `CLIENT_ID` when calling via webhook. ||" }, "SUB_TAG": { "type": "string", "description": "| An additional notification tag without uniqueness checks. Pass it with `CLIENT_ID` when calling via webhook. ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user receiving the notification." }, "TYPE": { "type": "string", "description": "| The type of notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the ends of the string before sending. ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass it with `CLIENT_ID` when calling via webhook. ||" }, "SUB_TAG": { "type": "string", "description": "| An additional notification tag without uniqueness checks. Pass it with `CLIENT_ID` when calling via webhook. ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.answer": { "post": { "summary": "Responding to Notifications with Quick Response im.notify.answer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.answer` sends a text quick response to a notification.", "operationId": "im_notify_answer", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-answer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| The identifier of the notification that supports a quick response." }, "ANSWER_TEXT": { "type": "string", "description": "| The text of the quick response. ||" } }, "required": [ "NOTIFY_ID", "ANSWER_TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| The identifier of the notification that supports a quick response." }, "ANSWER_TEXT": { "type": "string", "description": "| The text of the quick response. ||" } }, "required": [ "NOTIFY_ID", "ANSWER_TEXT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.confirm": { "post": { "summary": "Interacting with Notification Buttons im.notify.confirm", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.confirm` sends the selected value of the notification button.", "operationId": "im_notify_confirm", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-confirm.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Identifier of the notification with buttons." }, "NOTIFY_VALUE": { "type": "string", "description": "| Value of the selected button. ||" } }, "required": [ "NOTIFY_ID", "NOTIFY_VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NOTIFY_ID": { "type": "integer", "description": "| Identifier of the notification with buttons." }, "NOTIFY_VALUE": { "type": "string", "description": "| Value of the selected button. ||" } }, "required": [ "NOTIFY_ID", "NOTIFY_VALUE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.delete": { "post": { "summary": "Delete Notification im.notify.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.delete` removes a notification by `ID` or by tags `TAG` and `SUB_TAG`. You must provide one of three parameters: `ID`, `TAG`, or `SUB_TAG`.", "operationId": "im_notify_delete", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the notification to be deleted ||" }, "TAG": { "type": "string", "description": "| Unique tag of the notification within the application. Only notifications from the current application are deleted ||" }, "SUB_TAG": { "type": "string", "description": "| Additional tag of the notification. Only notifications from the current application are deleted ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same `CLIENT_ID` that was specified during the chat bot registration ||" } }, "required": [ "ID", "TAG", "SUB_TAG" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the notification to be deleted ||" }, "TAG": { "type": "string", "description": "| Unique tag of the notification within the application. Only notifications from the current application are deleted ||" }, "SUB_TAG": { "type": "string", "description": "| Additional tag of the notification. Only notifications from the current application are deleted ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same `CLIENT_ID` that was specified during the chat bot registration ||" } }, "required": [ "ID", "TAG", "SUB_TAG" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.get": { "post": { "summary": "Get Notifications im.notify.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.get` returns a list of user notifications in parts. The next part is requested using `LAST_ID` and `LAST_TYPE`. Notification sorting: first by descending creation date, then by descending identifiers.", "operationId": "im_notify_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LAST_ID": { "type": "integer", "description": "| Identifier of the last notification from the previous page to load the next one. Typically taken from the `id` field of the last element in the `notifications` array in the response of the previous selection step or in the response of im.notify.history.search" }, "LAST_TYPE": { "type": "integer", "description": "| Technical pagination cursor." }, "LIMIT": { "type": "integer", "description": "| Number of notifications per page. Default value is `50`. Maximum value is `50` ||" }, "CONVERT_TEXT": { "type": "string", "description": "| Convert notification text. Value `Y` enables conversion, any other value disables it ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LAST_ID": { "type": "integer", "description": "| Identifier of the last notification from the previous page to load the next one. Typically taken from the `id` field of the last element in the `notifications` array in the response of the previous selection step or in the response of im.notify.history.search" }, "LAST_TYPE": { "type": "integer", "description": "| Technical pagination cursor." }, "LIMIT": { "type": "integer", "description": "| Number of notifications per page. Default value is `50`. Maximum value is `50` ||" }, "CONVERT_TEXT": { "type": "string", "description": "| Convert notification text. Value `Y` enables conversion, any other value disables it ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.history.search": { "post": { "summary": "Searching Notification History im.notify.history.search", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.history.search` performs a search through the user's notification history. Notifications are sorted first by descending creation date, then by descending identifiers.", "operationId": "im_notify_history_search", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-history-search.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SEARCH_TEXT": { "type": "string", "description": "| Search text. If `SEARCH_TYPE` and `SEARCH_DATE` are not specified, the string length must be at least `3` characters ||" }, "SEARCH_TYPE": { "type": "string", "description": "| Filter by notification type in the format `MODULE` or ```MODULE|EVENT```. Ready values can be obtained using the method im.notify.schema.get ||" }, "SEARCH_TYPES": { "type": "array", "items": {}, "description": "| Array of filters by notification types in the format `MODULE` or ```MODULE|EVENT``` ||" }, "SEARCH_DATE": { "type": "string", "description": "| Date filter in ISO 8601 format (RFC3339) ||" }, "SEARCH_DATE_FROM": { "type": "string", "description": "| Start of the date range in ISO 8601 format (RFC3339). Used together with `SEARCH_DATE_TO` ||" }, "SEARCH_DATE_TO": { "type": "string", "description": "| End of the date range in ISO 8601 format (RFC3339). Used together with `SEARCH_DATE_FROM` ||" }, "SEARCH_AUTHORS": { "type": "array", "items": {}, "description": "| Array of notification author identifiers for filtering ||" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last notification from the previous page to load the next one. Usually taken from the `id` field of the last element in the `notifications` array in the response of the previous search step or in the response of im.notify.get ||" }, "LIMIT": { "type": "integer", "description": "| Number of notifications per page. Default value is `50`. Maximum value is `50` ||" }, "CONVERT_TEXT": { "type": "string", "description": "| Convert notification text. Value `Y` enables conversion, any other value disables it ||" }, "GROUP_TAG": { "type": "string", "description": "| Group tag for notifications for additional filtering ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SEARCH_TEXT": { "type": "string", "description": "| Search text. If `SEARCH_TYPE` and `SEARCH_DATE` are not specified, the string length must be at least `3` characters ||" }, "SEARCH_TYPE": { "type": "string", "description": "| Filter by notification type in the format `MODULE` or ```MODULE|EVENT```. Ready values can be obtained using the method im.notify.schema.get ||" }, "SEARCH_TYPES": { "type": "array", "items": {}, "description": "| Array of filters by notification types in the format `MODULE` or ```MODULE|EVENT``` ||" }, "SEARCH_DATE": { "type": "string", "description": "| Date filter in ISO 8601 format (RFC3339) ||" }, "SEARCH_DATE_FROM": { "type": "string", "description": "| Start of the date range in ISO 8601 format (RFC3339). Used together with `SEARCH_DATE_TO` ||" }, "SEARCH_DATE_TO": { "type": "string", "description": "| End of the date range in ISO 8601 format (RFC3339). Used together with `SEARCH_DATE_FROM` ||" }, "SEARCH_AUTHORS": { "type": "array", "items": {}, "description": "| Array of notification author identifiers for filtering ||" }, "LAST_ID": { "type": "integer", "description": "| Identifier of the last notification from the previous page to load the next one. Usually taken from the `id` field of the last element in the `notifications` array in the response of the previous search step or in the response of im.notify.get ||" }, "LIMIT": { "type": "integer", "description": "| Number of notifications per page. Default value is `50`. Maximum value is `50` ||" }, "CONVERT_TEXT": { "type": "string", "description": "| Convert notification text. Value `Y` enables conversion, any other value disables it ||" }, "GROUP_TAG": { "type": "string", "description": "| Group tag for notifications for additional filtering ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.personal.add": { "post": { "summary": "Send Personal Notification im.notify.personal.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.personal.add` sends a personal notification on behalf of the current user. The method is only available when called through an application.", "operationId": "im_notify_personal_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-personal-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Identifier of the user receiving the notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the edges of the string before sending. Supports BB codes — see more in the Message Formatting section ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. If not provided, an empty value is sent ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with `CLIENT_ID` when calling via webhook ||" }, "SUB_TAG": { "type": "string", "description": "| An additional tag for the notification without uniqueness checks. Pass with `CLIENT_ID` when calling via webhook ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Identifier of the user receiving the notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the edges of the string before sending. Supports BB codes — see more in the Message Formatting section ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. If not provided, an empty value is sent ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with `CLIENT_ID` when calling via webhook ||" }, "SUB_TAG": { "type": "string", "description": "| An additional tag for the notification without uniqueness checks. Pass with `CLIENT_ID` when calling via webhook ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read": { "post": { "summary": "Read or Mark Notification as Unread im.notify.read", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read` marks a notification or all notifications as read or unread based on the specified parameters.", "operationId": "im_notify_read", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-read.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| The identifier of the notification. When `ID >= 0`, the status is changed; if `ID` is absent, the method will return `true` without any changes ||" }, "ACTION": { "type": "string", "description": "| Action on the notifications:" }, "ONLY_CURRENT": { "type": "string", "description": "| The value `Y` changes only the notification with the specified `ID`. Any other value changes notifications whose identifiers are equal to or greater than this `ID` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| The identifier of the notification. When `ID >= 0`, the status is changed; if `ID` is absent, the method will return `true` without any changes ||" }, "ACTION": { "type": "string", "description": "| Action on the notifications:" }, "ONLY_CURRENT": { "type": "string", "description": "| The value `Y` changes only the notification with the specified `ID`. Any other value changes notifications whose identifiers are equal to or greater than this `ID` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read.all": { "post": { "summary": "Read All Notifications im.notify.read.all", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read.all` marks all notifications of the current user as read.", "operationId": "im_notify_read_all", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-read-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.read.list": { "post": { "summary": "Read the list of notifications im.notify.read.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read.list` marks a list of notifications as read or unread.", "operationId": "im_notify_read_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-read-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IDS": { "type": "array", "items": {}, "description": "| An array of notification identifiers. If any value in the array is `<= 0`, processing stops at that element ||" }, "ACTION": { "type": "string", "description": "| Action on the notifications:" } }, "required": [ "IDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IDS": { "type": "array", "items": {}, "description": "| An array of notification identifiers. If any value in the array is `<= 0`, processing stops at that element ||" }, "ACTION": { "type": "string", "description": "| Action on the notifications:" } }, "required": [ "IDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.schema.get": { "post": { "summary": "Get Notification Type Schema im.notify.schema.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.schema.get` returns the schema of available notification types by modules.", "operationId": "im_notify_schema_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-schema-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.notify.system.add": { "post": { "summary": "Send System Notification im.notify.system.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.system.add` sends a system notification to a user. The method is only available when called through an application.", "operationId": "im_notify_system_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/notifications/im-notify-system-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Identifier of the user receiving the notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the edges of the string before sending. Supports BB codes — see more in the Message Formatting section. ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with `CLIENT_ID` when calling via webhook. ||" }, "SUB_TAG": { "type": "string", "description": "| An additional notification tag without uniqueness checks. Pass with `CLIENT_ID` when calling via webhook. ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| Identifier of the user receiving the notification." }, "MESSAGE": { "type": "string", "description": "| The text of the notification. The method trims whitespace from the edges of the string before sending. Supports BB codes — see more in the Message Formatting section. ||" }, "MESSAGE_OUT": { "type": "string", "description": "| The text of the notification for external channels, such as email. ||" }, "TAG": { "type": "string", "description": "| A unique tag for the notification within the application. When adding a notification with an existing tag, other notifications will be removed. Pass with `CLIENT_ID` when calling via webhook. ||" }, "SUB_TAG": { "type": "string", "description": "| An additional notification tag without uniqueness checks. Pass with `CLIENT_ID` when calling via webhook. ||" }, "ATTACH": { "type": "object" } }, "required": [ "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent": { "post": { "summary": "Pin a Chat at the Top of the im.recent List", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.pin` pins or unpins a conversation at the top of the user's chat list.", "operationId": "im_recent", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/special-operations/im-recent-pin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "PIN": { "type": "string", "description": "| Pin or unpin the conversation:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "PIN": { "type": "string", "description": "| Pin or unpin the conversation:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.get": { "post": { "summary": "Get a Shortened List of Recent Chats im.recent.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.get` retrieves a list of the user's recent chats.", "operationId": "im_recent_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-recent-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip chats from Open Channels." }, "SKIP_CHAT": { "type": "string", "description": "| Skip group chats." }, "SKIP_DIALOG": { "type": "string", "description": "| Skip one-on-one dialogs." }, "LAST_UPDATE": { "type": "string", "format": "date-time", "description": "| Retrieve data from the specified date in ATOM (ISO-8601) format ||" }, "ONLY_OPENLINES": { "type": "string", "description": "| Select only chats from Open Channels." }, "LAST_SYNC_DATE": { "type": "string", "format": "date-time", "description": "| Date of the previous retrieval in ATOM (ISO-8601) format to load changes that occurred in the list since the specified date." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip chats from Open Channels." }, "SKIP_CHAT": { "type": "string", "description": "| Skip group chats." }, "SKIP_DIALOG": { "type": "string", "description": "| Skip one-on-one dialogs." }, "LAST_UPDATE": { "type": "string", "format": "date-time", "description": "| Retrieve data from the specified date in ATOM (ISO-8601) format ||" }, "ONLY_OPENLINES": { "type": "string", "description": "| Select only chats from Open Channels." }, "LAST_SYNC_DATE": { "type": "string", "format": "date-time", "description": "| Date of the previous retrieval in ATOM (ISO-8601) format to load changes that occurred in the list since the specified date." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.hide": { "post": { "summary": "Remove Chat from the Recent List im.recent.hide", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.hide` removes a dialog from the list of recent chats for the current user. You can retrieve the list of recent chats using the [im.recent.get](../im-recent-get.md) method.", "operationId": "im_recent_hide", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/special-operations/im-recent-hide.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.list": { "post": { "summary": "Get the List of Chats im.recent.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.list` retrieves a list of the user's recent conversations with pagination support.", "operationId": "im_recent_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-recent-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip open channel chats." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip open channel chats." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.recent.unread": { "post": { "summary": "Set or Remove the \"Read\" Flag for the Chat im.recent.unread", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.unread` sets or removes the \"read\" flag for the chat.", "operationId": "im_recent_unread", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/special-operations/im-recent-unread.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "ACTION": { "type": "string", "description": "| Action for the \"read\" flag:" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the chat in the format:" }, "ACTION": { "type": "string", "description": "| Action for the \"read\" flag:" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.revision.get": { "post": { "summary": "Get API Revisions im.revision.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.revision.get` returns the API revisions of the [IM module](../../settings/cloud-and-on-premise/on-premise/versions.md) for the current Bitrix24. Use the revision values to check the compatibility of the client with the Bitrix24 server, especially on on-premise accounts where the module version may differ from the current one.", "operationId": "im_revision_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/im-revision-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.chat.list": { "post": { "summary": "Find Chats im.search.chat.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.chat.list` performs a search for chats that the current user has access to. The search is conducted based on the title, first name, and last name of chat participants. Results are sorted in descending order of identifiers.", "operationId": "im_search_chat_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-chat-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase for querying indexed chat data. The minimum number of characters for a search is `3` ||" }, "FIND_LINES": { "type": "string", "description": "| Search phrase for finding chats among Open Channels. The minimum number of characters for a search is `3` ||" }, "OFFSET": { "type": "integer", "description": "| Offset for the chat sample. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the sample. Default is `10`. Maximum value is `50` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase for querying indexed chat data. The minimum number of characters for a search is `3` ||" }, "FIND_LINES": { "type": "string", "description": "| Search phrase for finding chats among Open Channels. The minimum number of characters for a search is `3` ||" }, "OFFSET": { "type": "integer", "description": "| Offset for the chat sample. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the sample. Default is `10`. Maximum value is `50` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.department.list": { "post": { "summary": "Find Departments im.search.department.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.department.list` performs a search for departments by their full name.", "operationId": "im_search_department_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-department-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase for finding the full name of the department (field full_name) ||" }, "USER_DATA": { "type": "string", "description": "| Return the manager's data in the field manager_user_data." }, "OFFSET": { "type": "integer", "description": "| Offset for the department selection. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } }, "required": [ "FIND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase for finding the full name of the department (field full_name) ||" }, "USER_DATA": { "type": "string", "description": "| Return the manager's data in the field manager_user_data." }, "OFFSET": { "type": "integer", "description": "| Offset for the department selection. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } }, "required": [ "FIND" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.add": { "post": { "summary": "Add Entry to Search History im.search.last.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.add` adds a dialog to the last search history. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface.", "operationId": "im_search_last_add", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-last-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier for the message object: user or chat." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier for the message object: user or chat." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.delete": { "post": { "summary": "Delete Record from Search History im.search.last.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.delete` removes a dialog from the last search history. This method was designed for the previous version of the chat. In the current version of the chat M1, it works, but the results are not displayed in the interface.", "operationId": "im_search_last_delete", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-last-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier for the message object: user or chat." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier for the message object: user or chat." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.last.get": { "post": { "summary": "Get Search History im.search.last.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.get` returns a list of dialogs from the history of the last search. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface.", "operationId": "im_search_last_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-last-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip Open Channels chats." }, "SKIP_CHAT": { "type": "string", "description": "| Skip group chats." }, "SKIP_DIALOG": { "type": "string", "description": "| Skip personal dialogs." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SKIP_OPENLINES": { "type": "string", "description": "| Skip Open Channels chats." }, "SKIP_CHAT": { "type": "string", "description": "| Skip group chats." }, "SKIP_DIALOG": { "type": "string", "description": "| Skip personal dialogs." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.search.user.list": { "post": { "summary": "Find Users im.search.user.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.user.list` allows you to search for users by first name, last name, job title, and department.", "operationId": "im_search_user_list", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/search/im-search-user-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase. The minimum number of characters for the search is `3` ||" }, "BUSINESS": { "type": "string", "description": "| Search only among business users." }, "OFFSET": { "type": "integer", "description": "| Offset for the user selection. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } }, "required": [ "FIND" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FIND": { "type": "string", "description": "| Search phrase. The minimum number of characters for the search is `3` ||" }, "BUSINESS": { "type": "string", "description": "| Search only among business users." }, "OFFSET": { "type": "integer", "description": "| Offset for the user selection. Default is `0` ||" }, "LIMIT": { "type": "integer", "description": "| Number of items in the selection. Default is `10`. Maximum value is `50` ||" } }, "required": [ "FIND" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.get": { "post": { "summary": "Get User Data im.user.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.get` retrieves data about the current user or a user by `ID`.", "operationId": "im_user_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| User identifier. If not provided, the method will return data for the current user." }, "AVATAR_HR": { "type": "string", "description": "| Parameter to request the `avatar_hr` field with the high-resolution avatar URL. Acceptable values: `Y` or `N`, default is `N`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| User identifier. If not provided, the method will return data for the current user." }, "AVATAR_HR": { "type": "string", "description": "| Parameter to request the `avatar_hr` field with the high-resolution avatar URL. Acceptable values: `Y` or `N`, default is `N`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.list.get": { "post": { "summary": "Get User Data with im.user.list.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.list.get` returns data about users based on a list of identifiers. If the current user is an extranet user, the method will return data only for users from their extranet groups. User identifiers outside these groups will be skipped without error.", "operationId": "im_user_list_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-list-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {} }, "AVATAR_HR": { "type": "string", "description": "| Parameter to request the `avatar_hr` field with the high-resolution avatar URL. Acceptable values: `Y` or `N`, default is `N`." }, "RESULT_TYPE": { "type": "string", "description": "| Format of the `result`. The value `array` will return a standard array of user objects, any other value will return an object with user identifier keys ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "array", "items": {} }, "AVATAR_HR": { "type": "string", "description": "| Parameter to request the `avatar_hr` field with the high-resolution avatar URL. Acceptable values: `Y` or `N`, default is `N`." }, "RESULT_TYPE": { "type": "string", "description": "| Format of the `result`. The value `array` will return a standard array of user objects, any other value will return an object with user identifier keys ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.get": { "post": { "summary": "Get User Status im.user.status.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.get` returns the status of the current user. The method returns the status that was set using the [im.user.status.set](./im-user-status-set.md) method.", "operationId": "im_user_status_get", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-status-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.idle.end": { "post": { "summary": "Disable Automatic Status \"Away\" im.user.status.idle.end", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.idle.end` disables the automatic \"Away\" status for the current user. This method was designed for the previous version of the chat. In the current version of the chat M1, it works, but the results are not displayed in the interface. - [Bitrix24 Chat: New Messenger](https://helpdesk.bitrix24.com/open/25661218/)", "operationId": "im_user_status_idle_end", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-status-idle-end.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.idle.start": { "post": { "summary": "Enable Automatic Status \"Away\" im.user.status.idle.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.idle.start` enables the automatic status \"Away\" for the current user. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface. - [Bitrix24 Chat: New Messenger](https://helpdesk.bitrix24.com/open/25661218/)", "operationId": "im_user_status_idle_start", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-status-idle-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "AGO": { "type": "integer", "description": "| How many minutes ago to set the \"Away\" status. If the parameter is not provided, `10` is used. The minimum value is `1` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "AGO": { "type": "integer", "description": "| How many minutes ago to set the \"Away\" status. If the parameter is not provided, `10` is used. The minimum value is `1` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.user.status.set": { "post": { "summary": "Set User Status im.user.status.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.set` sets the current user's status. To check the current status, use the method [im.user.status.get](./im-user-status-get.md).", "operationId": "im_user_status_set", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/users/im-user-status-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "STATUS": { "type": "string", "description": "| The new status of the user. The value is case-sensitive and must be provided in lowercase." } }, "required": [ "STATUS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "STATUS": { "type": "string", "description": "| The new status of the user. The value is case-sensitive and must be provided in lowercase." } }, "required": [ "STATUS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2": { "post": { "summary": "Event Formats im.v2", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Description of all events that the user application receives via [im.v2.Event.get](./event-get.md). The fields of the `message`, `chat`, and `user` objects are described in [{#T}](../../entities.md). **Quick Navigation:** [ONIMV2MESSAGEADD](#onimv2messageadd) | [ONIMV2MESSAGEUPDATE](#onimv2messageupdate) | [ONIMV2MESSAGEDELETE](#onimv2messagedelete) | [ONIMV2REACTIONCHANGE](#onimv2reactionchange) | [ONIMV2JOINCHAT](#onimv2joinchat)", "operationId": "im_v2", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/events.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Type | Description ||" }, "message": { "type": "string", "description": "| `Message` | The sent message. The description of the object's fields — Message ||" }, "chat": { "type": "string", "description": "| `Chat` | The chat where the message was sent. The description of the object's fields — Chat ||" }, "user": { "type": "string", "description": "| `User` | The author of the message. The description of the object's fields — User ||" }, "language": { "type": "string", "description": "| `string` | The language of the account (e.g., `en`, `de`) ||" }, "messageId": { "type": "string", "description": "| `integer` | ID of the deleted message ||" }, "reaction": { "type": "string", "description": "| `string` | Reaction code (e.g., `like`) ||" }, "action": { "type": "string", "description": "| `string` | Action: `add` — reaction added, `delete` — removed ||" }, "dialogId": { "type": "string", "description": "| `string` | ID of the dialog (e.g., `chat5`) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "| Type | Description ||" }, "message": { "type": "string", "description": "| `Message` | The sent message. The description of the object's fields — Message ||" }, "chat": { "type": "string", "description": "| `Chat` | The chat where the message was sent. The description of the object's fields — Chat ||" }, "user": { "type": "string", "description": "| `User` | The author of the message. The description of the object's fields — User ||" }, "language": { "type": "string", "description": "| `string` | The language of the account (e.g., `en`, `de`) ||" }, "messageId": { "type": "string", "description": "| `integer` | ID of the deleted message ||" }, "reaction": { "type": "string", "description": "| `string` | Reaction code (e.g., `like`) ||" }, "action": { "type": "string", "description": "| `string` | Action: `add` — reaction added, `delete` — removed ||" }, "dialogId": { "type": "string", "description": "| `string` | ID of the dialog (e.g., `chat5`) ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/im.v2.Event.get": { "post": { "summary": "Get User Events im.v2.Event.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.get` retrieves events for the current user in polling mode. To receive events, the user must be previously subscribed via [im.v2.Event.subscribe](./event-subscribe.md). Without a subscription, events are not recorded, and the method will return an empty array. The method uses confirmation via `offset`: pass the `nextOffset` from the previous response to get the next batch of events.", "operationId": "im_v2_Event_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "description": "| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||" }, "limit": { "type": "integer", "description": "| Maximum number of events returned (1–1000). Default is `100` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "description": "| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||" }, "limit": { "type": "integer", "description": "| Maximum number of events returned (1–1000). Default is `100` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.Event.subscribe": { "post": { "summary": "Subscribe to Events im.v2.Event.subscribe", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.subscribe` subscribes the current user to event logging. After subscribing, message events are recorded in the log and become accessible through [im.v2.Event.get](./event-get.md). The method is idempotent: repeated calls are safe and do not result in an error.", "operationId": "im_v2_Event_subscribe", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.Event.unsubscribe": { "post": { "summary": "Unsubscribing from Events im.v2.Event.unsubscribe", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.Event.unsubscribe` cancels the current user's subscription to event logging. It stops recording new events in the log. Already recorded events remain accessible through [im.v2.Event.get](./event-get.md) until the retention period expires (24 hours) or until confirmed via `offset`. The method is idempotent: repeated calls are safe and do not result in an error.", "operationId": "im_v2_Event_unsubscribe", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.File.download": { "post": { "summary": "Get Download Link for File im.v2.File.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.File.download` returns a link to download a file from the chat.", "operationId": "im_v2_File_download", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fileId": { "type": "integer", "description": "| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||" } }, "required": [ "dialogId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fileId": { "type": "integer", "description": "| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||" } }, "required": [ "dialogId", "fileId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/im.v2.File.upload": { "post": { "summary": "Upload File to Chat im.v2.File.upload", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.v2.File.upload` uploads a file to the chat on behalf of the current user. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.", "operationId": "im_v2_File_upload", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Object with file and message parameters (detailed description) ||" }, "name": { "type": "string", "description": "| File name with extension ||" }, "content": { "type": "string", "description": "| File content in Base64 encoding. Maximum size — 100 MB ||" }, "message": { "type": "string", "description": "| Text of the message sent along with the file ||" } }, "required": [ "dialogId", "fields", "name", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dialogId": { "type": "string", "description": "| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Object with file and message parameters (detailed description) ||" }, "name": { "type": "string", "description": "| File name with extension ||" }, "content": { "type": "string", "description": "| File content in Base64 encoding. Maximum size — 100 MB ||" }, "message": { "type": "string", "description": "| Text of the message sent along with the file ||" } }, "required": [ "dialogId", "fields", "name", "content" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "im" ] } ] } }, "/imbot.app.register": { "post": { "summary": "Register a Chat Application imbot.app.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.register` registers a chat application. Applications are divided into two types: [JS command and IFRAME application](../chat-apps.md).", "operationId": "imbot_app_register", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/outdated/create-app/imbot-app-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "BOT_ID": { "type": "string", "description": "| `62` | Identifier of the bot that owns the chat application ||" }, "CODE": { "type": "string", "description": "| `'echo'` | Code of the chat application ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | Options for `JS_METHOD`:" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Icon in base64." }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Context of the application." }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Is the command available to extranet users, default is N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Online chat support ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | The iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window. ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Array of translations, it is advisable to specify at least for DE and EN ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "BOT_ID": { "type": "string", "description": "| `62` | Identifier of the bot that owns the chat application ||" }, "CODE": { "type": "string", "description": "| `'echo'` | Code of the chat application ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | Options for `JS_METHOD`:" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Icon in base64." }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Context of the application." }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Is the command available to extranet users, default is N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Online chat support ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | The iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window. ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Array of translations, it is advisable to specify at least for DE and EN ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.app.unregister": { "post": { "summary": "Unregister Chat Application imbot.app.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.unregister` removes the application from the chat.", "operationId": "imbot_app_unregister", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/outdated/create-app/imbot-app-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "APP_ID": { "type": "string", "description": "| `13` | Identifier of the application to be removed ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "APP_ID": { "type": "string", "description": "| `13` | Identifier of the application to be removed ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.app.update": { "post": { "summary": "Update Application Data in Chat imbot.app.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.update` updates application data in the chat. The required fields are the application ID and one of the necessary fields for editing. If both JS and IFRAME methods are specified in one command, only JS will be used.", "operationId": "imbot_app_update", "tags": [ "Chats" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chats/outdated/create-app/imbot-app-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "APP_ID": { "type": "string", "description": "| `13` | Chat identifier ||" }, "IFRAME": { "type": "string", "description": "| `'https://marta.bitrix.com/iframe/echo.php'` | URL of the frame ||" }, "IFRAME_WIDTH": { "type": "string", "description": "| `'350'` | Desired width of the frame. Minimum value - 250px ||" }, "IFRAME_HEIGHT": { "type": "string", "description": "| `'150'` | Desired height of the frame. Minimum value - 50px ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | ||" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "HASH": { "type": "string", "description": "| `'register'` | Token for accessing your frame, 32 characters ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Icon of your application - base64 ||" }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Application context ||" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Is the command available to extranet users, default N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Online chat support ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Array of translations, it is advisable to specify at least for DE and EN ||" } }, "required": [ "APP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Example | Description ||" }, "APP_ID": { "type": "string", "description": "| `13` | Chat identifier ||" }, "IFRAME": { "type": "string", "description": "| `'https://marta.bitrix.com/iframe/echo.php'` | URL of the frame ||" }, "IFRAME_WIDTH": { "type": "string", "description": "| `'350'` | Desired width of the frame. Minimum value - 250px ||" }, "IFRAME_HEIGHT": { "type": "string", "description": "| `'150'` | Desired height of the frame. Minimum value - 50px ||" }, "JS_METHOD": { "type": "string", "description": "| `'SEND'` | ||" }, "JS_PARAM": { "type": "string", "description": "| `'/help'` | ||" }, "HASH": { "type": "string", "description": "| `'register'` | Token for accessing your frame, 32 characters ||" }, "ICON_FILE": { "type": "string", "description": "| `'/* base64 image */'` | Icon of your application - base64 ||" }, "CONTEXT": { "type": "string", "description": "| `'BOT'` | Application context ||" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| `'N'` | Is the command available to extranet users, default N ||" }, "LIVECHAT_SUPPORT": { "type": "string", "description": "| `'N'` | Online chat support ||" }, "IFRAME_POPUP": { "type": "string", "description": "| `'N'` | iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window ||" }, "LANG": { "type": "string", "description": "| `Array(...)` | Array of translations, it is advisable to specify at least for DE and EN ||" } }, "required": [ "APP_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.bot.list": { "post": { "summary": "Get the List of Chat Bots imbot.bot.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.list](../../chat-bots-v2/imbot.v2/bots/bot-list.md). The method `imbot.bot.list` returns a list of registered chat bots. No parameters required.", "operationId": "imbot_bot_list", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-bot-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the chat bot ||" }, "NAME": { "type": "string", "description": "| Full name of the chat bot ||" }, "CODE": { "type": "string", "description": "| Code of the chat bot ||" }, "OPENLINE": { "type": "string", "description": "| Indicator of open line support: `Y` or `N` ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "ID": { "type": "integer", "description": "| Identifier of the chat bot ||" }, "NAME": { "type": "string", "description": "| Full name of the chat bot ||" }, "CODE": { "type": "string", "description": "| Code of the chat bot ||" }, "OPENLINE": { "type": "string", "description": "| Indicator of open line support: `Y` or `N` ||" }, "Code": { "type": "string", "description": "| Description | Value ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.add": { "post": { "summary": "Create a chat on behalf of the chat bot imbot.chat.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.add](../../chat-bots-v2/imbot.v2/chats/chat-add.md). The method `imbot.chat.add` creates a chat on behalf of the chat bot.", "operationId": "imbot_chat_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Type of chat. Possible values:" }, "TITLE": { "type": "string", "description": "| Title of the chat ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the chat ||" }, "COLOR": { "type": "string", "description": "| Color of the chat for the mobile application. Possible values:" }, "MESSAGE": { "type": "string", "description": "| Welcome message in the chat ||" }, "USERS": { "type": "array", "items": {}, "description": "| Array of chat participants ||" }, "AVATAR": { "type": "string", "description": "| Avatar of the chat in Base64 format." }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the object to bind the chat to an external context ||" }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TYPE": { "type": "string", "description": "| Type of chat. Possible values:" }, "TITLE": { "type": "string", "description": "| Title of the chat ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the chat ||" }, "COLOR": { "type": "string", "description": "| Color of the chat for the mobile application. Possible values:" }, "MESSAGE": { "type": "string", "description": "| Welcome message in the chat ||" }, "USERS": { "type": "array", "items": {}, "description": "| Array of chat participants ||" }, "AVATAR": { "type": "string", "description": "| Avatar of the chat in Base64 format." }, "ENTITY_TYPE": { "type": "string", "description": "| Type of the object to bind the chat to an external context ||" }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the object within `ENTITY_TYPE`." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.get": { "post": { "summary": "Get Chat ID imbot.chat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md). The method `imbot.chat.get` returns the chat ID. To obtain detailed information about the chat, use the method [imbot.dialog.get](./imbot-dialog-get.md).", "operationId": "imbot_chat_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Type of the external object." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the external object." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ENTITY_TYPE": { "type": "string", "description": "| Type of the external object." }, "ENTITY_ID": { "type": "string", "description": "| Identifier of the external object." } }, "required": [ "ENTITY_TYPE", "ENTITY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.leave": { "post": { "summary": "Chat Bot Exit from Specified Chat imbot.chat.leave", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.leave](../../chat-bots-v2/imbot.v2/chats/chat-leave.md). The method `imbot.chat.leave` removes the chat bot from the chat.", "operationId": "imbot_chat_leave", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-leave.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can get the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can get the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.sendTyping": { "post": { "summary": "Send Typing Indicator imbot.chat.sendTyping", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.InputAction.notify](../../chat-bots-v2/imbot.v2/ui/chat-input-action-notify.md). The method `imbot.chat.sendTyping` sends a typing indicator to the dialog. The method returns `true` immediately after the command is sent.", "operationId": "imbot_chat_sendTyping", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method." }, "DIALOG_ID": { "type": "string", "description": "| The identifier of the object that will receive the message: user or chat." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method." }, "DIALOG_ID": { "type": "string", "description": "| The identifier of the object that will receive the message: user or chat." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.setManager": { "post": { "summary": "Assign or Revoke Chat Administrator Rights imbot.chat.setManager", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. To assign or revoke administrator rights, use the methods [imbot.v2.Chat.Manager.add](../../chat-bots-v2/imbot.v2/chats/chat-manager-add.md) and [imbot.v2.Chat.Manager.delete](../../chat-bots-v2/imbot.v2/chats/chat-manager-delete.md). The method `imbot.chat.setManager` assigns a chat administrator or revokes administrator rights from a chat participant.", "operationId": "imbot_chat_setManager", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-set-manager.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user for whom the administrator status is being changed." }, "IS_MANAGER": { "type": "string", "description": "| Administrator status. Possible values:" }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. The bot identifier can be obtained using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the chat bot registration ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user for whom the administrator status is being changed." }, "IS_MANAGER": { "type": "string", "description": "| Administrator status. Possible values:" }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. The bot identifier can be obtained using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the chat bot registration ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.setOwner": { "post": { "summary": "Change Chat Owner via imbot.chat.setOwner", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.setOwner](../../chat-bots-v2/imbot.v2/chats/chat-set-owner.md). The method `imbot.chat.setOwner` changes the owner of the chat.", "operationId": "imbot_chat_setOwner", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-set-owner.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the new chat owner." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot identifier using the imbot.bot.list method." }, "CLIENT_ID": { "type": "string", "description": "| A technical parameter for scenarios without `clientId` in authorization." } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the new chat owner." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot identifier using the imbot.bot.list method." }, "CLIENT_ID": { "type": "string", "description": "| A technical parameter for scenarios without `clientId` in authorization." } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateAvatar": { "post": { "summary": "Change Chat Avatar imbot.chat.updateAvatar", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateAvatar` updates the chat avatar.", "operationId": "imbot_chat_updateAvatar", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-avatar.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "AVATAR": { "type": "string", "description": "| Image in Base64 format." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "AVATAR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "AVATAR": { "type": "string", "description": "| Image in Base64 format." }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "AVATAR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateColor": { "post": { "summary": "Change Chat Color imbot.chat.updateColor", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateColor` updates the chat color for the mobile application.", "operationId": "imbot_chat_updateColor", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-color.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "COLOR": { "type": "string", "description": "| The chat color for the mobile application. Possible values:" }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "COLOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "COLOR": { "type": "string", "description": "| The chat color for the mobile application. Possible values:" }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "COLOR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.updateTitle": { "post": { "summary": "Change Chat Title imbot.chat.updateTitle", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.update](../../chat-bots-v2/imbot.v2/chats/chat-update.md). The method `imbot.chat.updateTitle` updates the chat title.", "operationId": "imbot_chat_updateTitle", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-update-title.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "TITLE": { "type": "string", "description": "| The new title of the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chatbot. You can obtain the bot ID using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chatbot ||" } }, "required": [ "CHAT_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "TITLE": { "type": "string", "description": "| The new title of the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chatbot. You can obtain the bot ID using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chatbot ||" } }, "required": [ "CHAT_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.add": { "post": { "summary": "Add Participants to Chat imbot.chat.user.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.User.add](../../chat-bots-v2/imbot.v2/chats/chat-user-add.md). The method `imbot.chat.user.add` adds users to a chat.", "operationId": "imbot_chat_user_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USERS": { "type": "array", "items": {}, "description": "| Array of user identifiers to be added." }, "HIDE_HISTORY": { "type": "string", "description": "| Hide chat history for added users:" }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can obtain the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } }, "required": [ "CHAT_ID", "USERS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." }, "USERS": { "type": "array", "items": {}, "description": "| Array of user identifiers to be added." }, "HIDE_HISTORY": { "type": "string", "description": "| Hide chat history for added users:" }, "BOT_ID": { "type": "integer", "description": "| Identifier of the chat bot. You can obtain the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" } }, "required": [ "CHAT_ID", "USERS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.delete": { "post": { "summary": "Exclude Participants from Chat imbot.chat.user.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.User.delete](../../chat-bots-v2/imbot.v2/chats/chat-user-delete.md). The method `imbot.chat.user.delete` removes a user from the chat.", "operationId": "imbot_chat_user_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user to be removed from the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user to be removed from the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.chat.user.list": { "post": { "summary": "Get the List of Chat Participants imbot.chat.user.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.User.list](../../chat-bots-v2/imbot.v2/chats/chat-user-list.md). The method `imbot.chat.user.list` returns a list of identifiers for the chat participants.", "operationId": "imbot_chat_user_list", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-user-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can get the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat." }, "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can get the bot's identifier using the method imbot.bot.list." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.answer": { "post": { "summary": "Send a response to the command imbot.command.answer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.answer](../../chat-bots-v2/imbot.v2/commands/command-answer.md). The method `imbot.command.answer` publishes a response to a chat bot command.", "operationId": "imbot_command_answer", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-answer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Command identifier. Required if `COMMAND` is not provided ||" }, "COMMAND": { "type": "string", "description": "| Command text. Required if `COMMAND_ID` is not provided ||" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message to which the response is sent." }, "MESSAGE": { "type": "string", "description": "| Response text ||" }, "ATTACH": { "type": "object", "description": "| Object with an attachment to the message. Minimum format:" }, "KEYBOARD": { "type": "object", "description": "| Message keyboard. Minimum format:" }, "MENU": { "type": "object", "description": "| Context menu of the message. Minimum format:" }, "SYSTEM": { "type": "string", "description": "| Message type:" }, "URL_PREVIEW": { "type": "string", "description": "| Link transformation into rich links:" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "COMMAND_ID", "COMMAND", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Command identifier. Required if `COMMAND` is not provided ||" }, "COMMAND": { "type": "string", "description": "| Command text. Required if `COMMAND_ID` is not provided ||" }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message to which the response is sent." }, "MESSAGE": { "type": "string", "description": "| Response text ||" }, "ATTACH": { "type": "object", "description": "| Object with an attachment to the message. Minimum format:" }, "KEYBOARD": { "type": "object", "description": "| Message keyboard. Minimum format:" }, "MENU": { "type": "object", "description": "| Context menu of the message. Minimum format:" }, "SYSTEM": { "type": "string", "description": "| Message type:" }, "URL_PREVIEW": { "type": "string", "description": "| Link transformation into rich links:" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "COMMAND_ID", "COMMAND", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.register": { "post": { "summary": "Add the imbot.command.register Command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Command.register](../../chat-bots-v2/imbot.v2/commands/command-register.md). The `imbot.command.register` method registers a command for the chat bot.", "operationId": "imbot_command_register", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method ||" }, "COMMAND": { "type": "string", "description": "| The text of the command that the user types in the chat. Latin letters and numbers can be used without spaces and special characters ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| The URL of the event handler ONIMCOMMANDADD that is triggered when the command is used ||" }, "LANG": { "type": "array", "items": {}, "description": "| An array of localizations for the command. The structure is described below ||" }, "COMMON": { "type": "string", "description": "| Command availability:" }, "HIDDEN": { "type": "string", "description": "| Command visibility:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Command availability for extranet users:" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Language identifier, for example `de` or `en` ||" }, "TITLE": { "type": "string", "description": "| The name of the command in the selected language ||" }, "PARAMS": { "type": "string", "description": "| Parameter hints for the command in the selected language ||" } }, "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": "| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method ||" }, "COMMAND": { "type": "string", "description": "| The text of the command that the user types in the chat. Latin letters and numbers can be used without spaces and special characters ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| The URL of the event handler ONIMCOMMANDADD that is triggered when the command is used ||" }, "LANG": { "type": "array", "items": {}, "description": "| An array of localizations for the command. The structure is described below ||" }, "COMMON": { "type": "string", "description": "| Command availability:" }, "HIDDEN": { "type": "string", "description": "| Command visibility:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Command availability for extranet users:" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Language identifier, for example `de` or `en` ||" }, "TITLE": { "type": "string", "description": "| The name of the command in the selected language ||" }, "PARAMS": { "type": "string", "description": "| Parameter hints for the command in the selected language ||" } }, "required": [ "BOT_ID", "COMMAND", "EVENT_COMMAND_ADD", "LANG", "LANGUAGE_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.unregister": { "post": { "summary": "Remove the imbot.command.unregister Command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.unregister](../../chat-bots-v2/imbot.v2/commands/command-unregister.md). The method `imbot.command.unregister` removes a registered command from the chat bot.", "operationId": "imbot_command_unregister", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Identifier of the command to be removed ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "COMMAND_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Identifier of the command to be removed ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" } }, "required": [ "COMMAND_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.command.update": { "post": { "summary": "Update the imbot.command.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Command.update](../../chat-bots-v2/imbot.v2/commands/command-update.md). The method `imbot.command.update` updates the parameters of a registered chat bot command.", "operationId": "imbot_command_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/commands/imbot-command-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Identifier of the command to be updated ||" }, "FIELDS": { "type": "object", "description": "| Object containing fields to update. The structure is described below ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" }, "COMMAND": { "type": "string", "description": "| Command text ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL of the event handler ONIMCOMMANDADD ||" }, "HIDDEN": { "type": "string", "description": "| Command visibility:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Availability for extranet users:" }, "LANG": { "type": "array", "items": {}, "description": "| Array of command localizations. The structure is described below ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Language identifier, e.g., `de` or `en` ||" }, "TITLE": { "type": "string", "description": "| Command title in the selected language ||" }, "PARAMS": { "type": "string", "description": "| Parameter hint for the command in the selected language ||" } }, "required": [ "COMMAND_ID", "FIELDS", "LANGUAGE_ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMAND_ID": { "type": "integer", "description": "| Identifier of the command to be updated ||" }, "FIELDS": { "type": "object", "description": "| Object containing fields to update. The structure is described below ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||" }, "COMMAND": { "type": "string", "description": "| Command text ||" }, "EVENT_COMMAND_ADD": { "type": "string", "description": "| URL of the event handler ONIMCOMMANDADD ||" }, "HIDDEN": { "type": "string", "description": "| Command visibility:" }, "EXTRANET_SUPPORT": { "type": "string", "description": "| Availability for extranet users:" }, "LANG": { "type": "array", "items": {}, "description": "| Array of command localizations. The structure is described below ||" }, "LANGUAGE_ID": { "type": "string", "description": "| Language identifier, e.g., `de` or `en` ||" }, "TITLE": { "type": "string", "description": "| Command title in the selected language ||" }, "PARAMS": { "type": "string", "description": "| Parameter hint for the command in the selected language ||" } }, "required": [ "COMMAND_ID", "FIELDS", "LANGUAGE_ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.dialog.get": { "post": { "summary": "Get Data About Chat imbot.dialog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md). The method `imbot.dialog.get` returns data about the chat.", "operationId": "imbot_dialog_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-dialog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the object." } }, "required": [ "DIALOG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DIALOG_ID": { "type": "string", "description": "| Identifier of the object." } }, "required": [ "DIALOG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.add": { "post": { "summary": "Send Message imbot.message.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [imbot.v2.Chat.Message.send](../../chat-bots-v2/imbot.v2/messages/chat-message-send.md). The method `imbot.message.add` sends a message from the chat bot.", "operationId": "imbot_message_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| The identifier of the object that will receive the message: user or chat." }, "FROM_USER_ID": { "type": "integer", "description": "| The identifier of the sender for sending in a private dialog. You can obtain the user ID using user.get and user.search." }, "TO_USER_ID": { "type": "integer", "description": "| The identifier of the recipient for sending in a private dialog. You can obtain the user ID using user.get and user.search." }, "MESSAGE": { "type": "string", "description": "| The text of the message. The method automatically trims spaces and line breaks from the edges of the message text. ||" }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Indicator of a system message." }, "URL_PREVIEW": { "type": "string", "description": "| Controls the display of links: when enabled, the link is shown as a \"rich link\" with a card." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Skip sending the message to external connectors of open channels." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "DIALOG_ID": { "type": "string", "description": "| The identifier of the object that will receive the message: user or chat." }, "FROM_USER_ID": { "type": "integer", "description": "| The identifier of the sender for sending in a private dialog. You can obtain the user ID using user.get and user.search." }, "TO_USER_ID": { "type": "integer", "description": "| The identifier of the recipient for sending in a private dialog. You can obtain the user ID using user.get and user.search." }, "MESSAGE": { "type": "string", "description": "| The text of the message. The method automatically trims spaces and line breaks from the edges of the message text. ||" }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "SYSTEM": { "type": "string", "description": "| Indicator of a system message." }, "URL_PREVIEW": { "type": "string", "description": "| Controls the display of links: when enabled, the link is shown as a \"rich link\" with a card." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Skip sending the message to external connectors of open channels." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.delete": { "post": { "summary": "Delete Message imbot.message.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.Message.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-delete.md). The method `imbot.message.delete` removes a message from the chat bot.", "operationId": "imbot_message_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message to be deleted. The value must be greater than `0`." }, "COMPLETE": { "type": "string", "description": "| Deletion mode." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message to be deleted. The value must be greater than `0`." }, "COMPLETE": { "type": "string", "description": "| Deletion mode." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.like": { "post": { "summary": "Set \"Like\" for the message imbot.message.like", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use the methods [imbot.v2.Chat.Message.Reaction.add](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.md) and [imbot.v2.Chat.Message.Reaction.delete](../../chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.md). The method `imbot.message.like` sets or removes the \"Like\" mark for a message.", "operationId": "imbot_message_like", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-like.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message in personal dialogs or group chats where the chat bot is present. The value must be greater than `0`." }, "ACTION": { "type": "string", "description": "| The action for the message reaction." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message in personal dialogs or group chats where the chat bot is present. The value must be greater than `0`." }, "ACTION": { "type": "string", "description": "| The action for the message reaction." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.message.update": { "post": { "summary": "Update Sent Message imbot.message.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Chat.Message.update](../../chat-bots-v2/imbot.v2/messages/chat-message-update.md). The method `imbot.message.update` modifies a previously sent message from the chat bot.", "operationId": "imbot_message_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/messages/imbot-message-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. It can be obtained using the imbot.bot.list method." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message to be modified. The value must be greater than `0`." }, "MESSAGE": { "type": "string", "description": "| The new text of the message. If an empty value is provided, the message will be deleted." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Controls the display of links: when enabled, the link is shown as a \"rich link\" with a card." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Skips sending the message to external connectors of open channels when updating `MESSAGE`." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. It can be obtained using the imbot.bot.list method." }, "MESSAGE_ID": { "type": "integer", "description": "| The identifier of the message to be modified. The value must be greater than `0`." }, "MESSAGE": { "type": "string", "description": "| The new text of the message. If an empty value is provided, the message will be deleted." }, "ATTACH": { "type": "object" }, "KEYBOARD": { "type": "object" }, "MENU": { "type": "object" }, "URL_PREVIEW": { "type": "string", "description": "| Controls the display of links: when enabled, the link is shown as a \"rich link\" with a card." }, "SKIP_CONNECTOR": { "type": "string", "description": "| Skips sending the message to external connectors of open channels when updating `MESSAGE`." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.register": { "post": { "summary": "Create a Chat-Bot imbot.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.register](../../chat-bots-v2/imbot.v2/bots/bot-register.md). The method `imbot.register` registers a chat-bot and binds event handlers of the application.", "operationId": "imbot_register", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The string code of the bot, unique within Bitrix24 ||" }, "TYPE": { "type": "string", "description": "| The type of the bot." }, "OPENLINE": { "type": "string", "description": "| Operation mode with Open Channels." }, "EVENT_HANDLER": { "type": "string", "description": "| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEUPDATE." }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEDELETE." }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL for the event handler ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTDELETE ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Provide a unique CLIENT_ID — this key will be linked to the chat-bot and will be needed for all subsequent calls to imbot* via webhook ||" }, "PROPERTIES": { "type": "object", "description": "| Properties of the chat-bot profile. The structure of the object is described in detail below ||" }, "NAME": { "type": "string", "description": "| The name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||" }, "LAST_NAME": { "type": "string", "description": "| The last name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||" }, "COLOR": { "type": "string", "description": "| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email for contacting the chat-bot. The bot is created as a user, so the bot's email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| Birthday in the format `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Position or description of the chat-bot ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Website link ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Gender, allowed values: `M` or `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Avatar of the chat-bot in Base64" } }, "required": [ "CODE", "EVENT_MESSAGE_ADD", "EVENT_WELCOME_MESSAGE", "EVENT_BOT_DELETE", "PROPERTIES", "NAME", "LAST_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The string code of the bot, unique within Bitrix24 ||" }, "TYPE": { "type": "string", "description": "| The type of the bot." }, "OPENLINE": { "type": "string", "description": "| Operation mode with Open Channels." }, "EVENT_HANDLER": { "type": "string", "description": "| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEUPDATE." }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEDELETE." }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL for the event handler ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTDELETE ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Provide a unique CLIENT_ID — this key will be linked to the chat-bot and will be needed for all subsequent calls to imbot* via webhook ||" }, "PROPERTIES": { "type": "object", "description": "| Properties of the chat-bot profile. The structure of the object is described in detail below ||" }, "NAME": { "type": "string", "description": "| The name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||" }, "LAST_NAME": { "type": "string", "description": "| The last name of the chat-bot. You must provide either `NAME` or `LAST_NAME` ||" }, "COLOR": { "type": "string", "description": "| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email for contacting the chat-bot. The bot is created as a user, so the bot's email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| Birthday in the format `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Position or description of the chat-bot ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Website link ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Gender, allowed values: `M` or `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Avatar of the chat-bot in Base64" } }, "required": [ "CODE", "EVENT_MESSAGE_ADD", "EVENT_WELCOME_MESSAGE", "EVENT_BOT_DELETE", "PROPERTIES", "NAME", "LAST_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.unregister": { "post": { "summary": "Unregister Chat Bot imbot.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.unregister](../../chat-bots-v2/imbot.v2/bots/bot-unregister.md). The method `imbot.unregister` removes a chat bot. When deleting the bot, personal chats with users will also be deleted.", "operationId": "imbot_unregister", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. The value must be greater than `0`." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "BOT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat bot. The value must be greater than `0`." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot. ||" } }, "required": [ "BOT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.update": { "post": { "summary": "Update Chat-Bot imbot.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [imbot.v2.Bot.update](../../chat-bots-v2/imbot.v2/bots/bot-update.md). The `imbot.update` method updates the data of the chat-bot and its event handlers.", "operationId": "imbot_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat-bot. You can obtain the identifier using the imbot.bot.list method. The value must be greater than `0` ||" }, "FIELDS": { "type": "object", "description": "| Data for updating the chat-bot. The structure of the object is described in detail below ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat-bot ||" }, "CODE": { "type": "string", "description": "| New string code for the bot, unique within Bitrix24 ||" }, "EVENT_HANDLER": { "type": "string", "description": "| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEUPDATE ||" }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEDELETE ||" }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL for the event handler ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTDELETE ||" }, "PROPERTIES": { "type": "object", "description": "| Properties of the chat-bot profile. The structure of the object is described in detail below ||" }, "NAME": { "type": "string", "description": "| The name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||" }, "LAST_NAME": { "type": "string", "description": "| The last name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||" }, "COLOR": { "type": "string", "description": "| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email for contacting the chat-bot. The bot is created as a user, so the bot's email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| Birthday in the format `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Position or description of the chat-bot ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Link to the website ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Gender, acceptable values: `M` or `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Avatar of the chat-bot in Base64" } }, "required": [ "BOT_ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "BOT_ID": { "type": "integer", "description": "| The identifier of the chat-bot. You can obtain the identifier using the imbot.bot.list method. The value must be greater than `0` ||" }, "FIELDS": { "type": "object", "description": "| Data for updating the chat-bot. The structure of the object is described in detail below ||" }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat-bot ||" }, "CODE": { "type": "string", "description": "| New string code for the bot, unique within Bitrix24 ||" }, "EVENT_HANDLER": { "type": "string", "description": "| General URL for the event handler. If provided, its value is copied to `EVENT_MESSAGE_ADD`, `EVENT_MESSAGE_UPDATE`, `EVENT_MESSAGE_DELETE`, `EVENT_WELCOME_MESSAGE`, `EVENT_BOT_DELETE`." }, "EVENT_MESSAGE_ADD": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEADD ||" }, "EVENT_MESSAGE_UPDATE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEUPDATE ||" }, "EVENT_MESSAGE_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTMESSAGEDELETE ||" }, "EVENT_WELCOME_MESSAGE": { "type": "string", "description": "| URL for the event handler ONIMBOTJOINCHAT ||" }, "EVENT_BOT_DELETE": { "type": "string", "description": "| URL for the event handler ONIMBOTDELETE ||" }, "PROPERTIES": { "type": "object", "description": "| Properties of the chat-bot profile. The structure of the object is described in detail below ||" }, "NAME": { "type": "string", "description": "| The name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||" }, "LAST_NAME": { "type": "string", "description": "| The last name of the chat-bot. If both values `NAME` and `LAST_NAME` are provided, they must not be empty at the same time ||" }, "COLOR": { "type": "string", "description": "| The color of the chat-bot for the mobile interface: `RED`, `GREEN`, `MINT`, `LIGHT_BLUE`, `DARK_BLUE`, `PURPLE`, `AQUA`, `PINK`, `LIME`, `BROWN`, `AZURE`, `KHAKI`, `SAND`, `MARENGO`, `GRAY`, `GRAPHITE` ||" }, "EMAIL": { "type": "string", "description": "| Email for contacting the chat-bot. The bot is created as a user, so the bot's email must not match the email of a real Bitrix24 user. This will help avoid account conflicts ||" }, "PERSONAL_BIRTHDAY": { "type": "string", "description": "| Birthday in the format `YYYY-MM-DD` ||" }, "WORK_POSITION": { "type": "string", "description": "| Position or description of the chat-bot ||" }, "PERSONAL_WWW": { "type": "string", "description": "| Link to the website ||" }, "PERSONAL_GENDER": { "type": "string", "description": "| Gender, acceptable values: `M` or `F` ||" }, "PERSONAL_PHOTO": { "type": "string", "description": "| Avatar of the chat-bot in Base64" } }, "required": [ "BOT_ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2": { "post": { "summary": "Change Log for API imbot.v2", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The change log for API `imbot.v2`: new features, fixes, and changes with breaking changes. Entries are listed from newest to oldest.", "operationId": "imbot_v2", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/change-log.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/imbot.v2.Bot.get": { "post": { "summary": "Get Information About the Bot imbot.v2.Bot.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.get` returns information about the bot. It is used to verify the bot's installation. For the owner application, it returns an extended format (including `moduleId`, `appId`, `eventMode`, and counters). For other applications, it returns a brief format.", "operationId": "imbot_v2_Bot_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID. Required if `code` is not specified ||" }, "code": { "type": "string", "description": "| Bot code. Required if `botId` is not specified ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID. Required if `code` is not specified ||" }, "code": { "type": "string", "description": "| Bot code. Required if `botId` is not specified ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.list": { "post": { "summary": "List of Bots for the imbot.v2.Bot.list Application", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.list` returns a list of bots for the current application in an extended format.", "operationId": "imbot_v2_Bot_list", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "filter": { "type": "object", "description": "| Filter for results." }, "limit": { "type": "integer", "description": "| Number of bots per page. Default is `50` ||" }, "offset": { "type": "integer", "description": "| Offset for pagination. Default is `0` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "filter": { "type": "object", "description": "| Filter for results." }, "limit": { "type": "integer", "description": "| Number of bots per page. Default is `50` ||" }, "offset": { "type": "integer", "description": "| Offset for pagination. Default is `0` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.register": { "post": { "summary": "Register a bot imbot.v2.Bot.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.register` registers a new chat bot. The method is idempotent: a repeated call with the same `fields.code` from the same application returns the existing bot without updating the data. To update, use [imbot.v2.Bot.update](./bot-update.md).", "operationId": "imbot_v2_Bot_register", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with bot parameters. Parameter descriptions are provided below ||" }, "code": { "type": "string", "description": "| Unique code for the bot within the application ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for authorization via webhook, not needed for OAuth." }, "properties": { "type": "object", "description": "| Properties of the bot's profile. Parameter descriptions are provided below ||" }, "type": { "type": "string", "description": "| Type of the bot. Descriptions of types and their behaviors can be found in Bot Types." }, "eventMode": { "type": "string", "description": "| Event delivery mode." }, "webhookUrl": { "type": "string", "description": "| URL of the bot's event handler. Required when `eventMode = webhook` ||" }, "isHidden": { "type": "boolean", "description": "| Hidden bot. Allowed values: `true`, `false`. Default is `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Enable support for reactions. Allowed values: `true`, `false`. Default is `true` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Enable support for Open Channels. Allowed values: `true`, `false`. Default is `false` ||" }, "backgroundId": { "type": "string", "description": "| Background of the bot's chat. Default is `null` — uses the background from user settings. Available values are in the backgrounds table. An invalid value is normalized to `null` ||" }, "name": { "type": "string", "description": "| Name of the bot. Displayed in the chat list and dialog header ||" }, "lastName": { "type": "string", "description": "| Last name of the bot ||" }, "workPosition": { "type": "string", "description": "| Position of the bot (displayed in the profile) ||" }, "color": { "type": "string", "description": "| Avatar color, available colors." }, "gender": { "type": "string", "description": "| Gender. Allowed values: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`." }, "ID": { "type": "string", "description": "| Theme | Color ||" } }, "required": [ "fields", "code", "properties", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with bot parameters. Parameter descriptions are provided below ||" }, "code": { "type": "string", "description": "| Unique code for the bot within the application ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for authorization via webhook, not needed for OAuth." }, "properties": { "type": "object", "description": "| Properties of the bot's profile. Parameter descriptions are provided below ||" }, "type": { "type": "string", "description": "| Type of the bot. Descriptions of types and their behaviors can be found in Bot Types." }, "eventMode": { "type": "string", "description": "| Event delivery mode." }, "webhookUrl": { "type": "string", "description": "| URL of the bot's event handler. Required when `eventMode = webhook` ||" }, "isHidden": { "type": "boolean", "description": "| Hidden bot. Allowed values: `true`, `false`. Default is `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Enable support for reactions. Allowed values: `true`, `false`. Default is `true` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Enable support for Open Channels. Allowed values: `true`, `false`. Default is `false` ||" }, "backgroundId": { "type": "string", "description": "| Background of the bot's chat. Default is `null` — uses the background from user settings. Available values are in the backgrounds table. An invalid value is normalized to `null` ||" }, "name": { "type": "string", "description": "| Name of the bot. Displayed in the chat list and dialog header ||" }, "lastName": { "type": "string", "description": "| Last name of the bot ||" }, "workPosition": { "type": "string", "description": "| Position of the bot (displayed in the profile) ||" }, "color": { "type": "string", "description": "| Avatar color, available colors." }, "gender": { "type": "string", "description": "| Gender. Allowed values: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`." }, "ID": { "type": "string", "description": "| Theme | Color ||" } }, "required": [ "fields", "code", "properties", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.unregister": { "post": { "summary": "Remove the Automation rule imbot.v2.Bot.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.unregister` removes the bot.", "operationId": "imbot_v2_Bot_unregister", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Bot.update": { "post": { "summary": "Update the Automation rule imbot.v2.Bot.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Bot.update` updates the properties of the Automation rule.", "operationId": "imbot_v2_Bot_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/bots/bot-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID of the Automation rule ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the Automation rule. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Fields to be updated. The structure of the object is described below ||" }, "properties": { "type": "object", "description": "| Properties of the Automation rule profile. Description of parameters — below ||" }, "isHidden": { "type": "boolean", "description": "| Hidden Automation rule. Acceptable values: `true`, `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Support for reactions. Acceptable values: `true`, `false` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Support for Open Channels. Acceptable values: `true`, `false` ||" }, "backgroundId": { "type": "string", "description": "| Background of the Automation rule chat. Pass `null` to reset to the user's background. Available values are in the backgrounds table. Invalid values are normalized to `null` ||" }, "eventMode": { "type": "string", "description": "| Event delivery mode: `fetch` or `webhook` ||" }, "webhookUrl": { "type": "string", "description": "| URL of the event handler (applies when `eventMode = webhook`) ||" }, "name": { "type": "string", "description": "| Name of the Automation rule ||" }, "lastName": { "type": "string", "description": "| Last name of the Automation rule ||" }, "workPosition": { "type": "string", "description": "| Position of the Automation rule (displayed in the profile) ||" }, "color": { "type": "string", "description": "| Avatar color, available colors." }, "gender": { "type": "string", "description": "| Gender. Acceptable values: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`." } }, "required": [ "botId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| ID of the Automation rule ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the Automation rule. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Fields to be updated. The structure of the object is described below ||" }, "properties": { "type": "object", "description": "| Properties of the Automation rule profile. Description of parameters — below ||" }, "isHidden": { "type": "boolean", "description": "| Hidden Automation rule. Acceptable values: `true`, `false` ||" }, "isReactionsEnabled": { "type": "boolean", "description": "| Support for reactions. Acceptable values: `true`, `false` ||" }, "isSupportOpenline": { "type": "boolean", "description": "| Support for Open Channels. Acceptable values: `true`, `false` ||" }, "backgroundId": { "type": "string", "description": "| Background of the Automation rule chat. Pass `null` to reset to the user's background. Available values are in the backgrounds table. Invalid values are normalized to `null` ||" }, "eventMode": { "type": "string", "description": "| Event delivery mode: `fetch` or `webhook` ||" }, "webhookUrl": { "type": "string", "description": "| URL of the event handler (applies when `eventMode = webhook`) ||" }, "name": { "type": "string", "description": "| Name of the Automation rule ||" }, "lastName": { "type": "string", "description": "| Last name of the Automation rule ||" }, "workPosition": { "type": "string", "description": "| Position of the Automation rule (displayed in the profile) ||" }, "color": { "type": "string", "description": "| Avatar color, available colors." }, "gender": { "type": "string", "description": "| Gender. Acceptable values: `M`, `F` ||" }, "avatar": { "type": "string", "description": "| Avatar. Pass a Base64 string without the prefix `data:*/*;base64,`." } }, "required": [ "botId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.InputAction.notify": { "post": { "summary": "Send the bot action indicator imbot.v2.Chat.InputAction.notify", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.InputAction.notify` sends a bot action indicator to the chat — for example, \"bot is typing\".", "operationId": "imbot_v2_Chat_InputAction_notify", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-input-action-notify.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "statusMessageCode": { "type": "string", "description": "| Action status code. A list of available codes is described below. If not specified, the standard \"typing\" indicator is displayed ||" }, "duration": { "type": "integer", "description": "| Duration of the indicator display in seconds (1–600). Default is determined by the server ||" }, "Code": { "type": "string", "description": "| Displayed Text ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "statusMessageCode": { "type": "string", "description": "| Action status code. A list of available codes is described below. If not specified, the standard \"typing\" indicator is displayed ||" }, "duration": { "type": "integer", "description": "| Duration of the indicator display in seconds (1–600). Default is determined by the server ||" }, "Code": { "type": "string", "description": "| Displayed Text ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Manager.add": { "post": { "summary": "Add Chat Managers imbot.v2.Chat.Manager.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Manager.add` adds users to the current list of chat managers. The bot must be the owner of the chat. Users who are not participants in the chat will be ignored without an error.", "operationId": "imbot_v2_Chat_Manager_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to be assigned as managers ||" } }, "required": [ "botId", "dialogId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to be assigned as managers ||" } }, "required": [ "botId", "dialogId", "userIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Manager.delete": { "post": { "summary": "Remove Chat Managers imbot.v2.Chat.Manager.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Manager.delete` removes users from the chat manager list. The bot must be the owner of the chat.", "operationId": "imbot_v2_Chat_Manager_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-manager-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to remove the manager role ||" } }, "required": [ "botId", "dialogId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to remove the manager role ||" } }, "required": [ "botId", "dialogId", "userIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.Reaction.add": { "post": { "summary": "Add Reaction to Message imbot.v2.Chat.Message.Reaction.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.Reaction.add` adds a bot reaction to a message.", "operationId": "imbot_v2_Chat_Message_Reaction_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" }, "reaction": { "type": "string", "description": "| Reaction code. The list of available codes is described below ||" }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "botId", "messageId", "reaction" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" }, "reaction": { "type": "string", "description": "| Reaction code. The list of available codes is described below ||" }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "botId", "messageId", "reaction" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.Reaction.delete": { "post": { "summary": "Remove Reaction from Message imbot.v2.Chat.Message.Reaction.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.Reaction.delete` removes the bot's reaction from a message.", "operationId": "imbot_v2_Chat_Message_Reaction_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-reaction-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" }, "reaction": { "type": "string", "description": "| Reaction code to be removed. List of available codes: imbot.v2.Chat.Message.Reaction.add ||" } }, "required": [ "botId", "messageId", "reaction" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" }, "reaction": { "type": "string", "description": "| Reaction code to be removed. List of available codes: imbot.v2.Chat.Message.Reaction.add ||" } }, "required": [ "botId", "messageId", "reaction" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.delete": { "post": { "summary": "Delete Message imbot.v2.Chat.Message.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.delete` removes a message. The bot can delete its own messages. If the bot is an administrator of the chat, it can delete any message. Messages sent with the parameter `system: true` have `authorId = 0`. The bot will not be able to delete such a message unless it is an administrator of the chat.", "operationId": "imbot_v2_Chat_Message_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the message to be deleted ||" }, "complete": { "type": "boolean", "description": "| Complete removal from the database. Acceptable values: `true`, `false`. Default is `false` (soft delete) ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the message to be deleted ||" }, "complete": { "type": "boolean", "description": "| Complete removal from the database. Acceptable values: `true`, `false`. Default is `false` (soft delete) ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.get": { "post": { "summary": "Get Message imbot.v2.Chat.Message.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.get` returns a message by its ID. Typical use-case: the bot received an event with `replyId` and wants to read the original message. The method is available only for `supervisor` and `personal` type bots. For more details, see [Bot Types](../../../index.md#bot-types).", "operationId": "imbot_v2_Chat_Message_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| Message ID ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.getContext": { "post": { "summary": "Get Context of Message imbot.v2.Chat.Message.getContext", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.getContext` returns a window of messages surrounding the specified one. It is used for analyzing the dialogue history. The method is only available for `supervisor` and `personal` type bots. For more details, see [Bot Types](../../../index.md#bot-types).", "operationId": "imbot_v2_Chat_Message_getContext", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-get-context.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the central message ||" }, "range": { "type": "integer", "description": "| Number of messages on each side of the central one (1–50). Default is `50` ||" } }, "required": [ "botId", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the central message ||" }, "range": { "type": "integer", "description": "| Number of messages on each side of the central one (1–50). Default is `50` ||" } }, "required": [ "botId", "messageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.read": { "post": { "summary": "Mark Messages as Read imbot.v2.Chat.Message.read", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.read` marks messages as read on behalf of the bot. It marks all messages up to and including the specified one as read. If `messageId` is not specified, it marks all messages in the chat as read.", "operationId": "imbot_v2_Chat_Message_read", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-read.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "messageId": { "type": "integer", "description": "| Read all messages up to and including this one. If not specified, it will read all messages in the chat ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "messageId": { "type": "integer", "description": "| Read all messages up to and including this one. If not specified, it will read all messages in the chat ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.send": { "post": { "summary": "Send Message imbot.v2.Chat.Message.send", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.send` sends a message on behalf of the bot to the specified dialog.", "operationId": "imbot_v2_Chat_Message_send", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Message content. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| Message text. Maximum length — 20,000 characters. If exceeded, the text is truncated with ` (...)` added ||" }, "attach": { "type": "array", "items": {}, "description": "| Attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Keyboard with buttons. More details: Working with Keyboards ||" }, "system": { "type": "boolean", "description": "| System message. Allowed values: `true`, `false`. Default is `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Show link previews. Allowed values: `true`, `false`. Default is `true` ||" }, "replyId": { "type": "integer", "description": "| ID of the message being replied to by the bot ||" }, "templateId": { "type": "string", "description": "| UUID of the message template ||" }, "forwardIds": { "type": "object", "description": "| Messages to forward. Format: `{uuid: messageId}`, where `uuid` is an arbitrary UUID string as the key, `messageId` is the ID of the original message. In the response, `uuidMap` will return `{uuid: newMessageId}`." } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Message content. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| Message text. Maximum length — 20,000 characters. If exceeded, the text is truncated with ` (...)` added ||" }, "attach": { "type": "array", "items": {}, "description": "| Attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Keyboard with buttons. More details: Working with Keyboards ||" }, "system": { "type": "boolean", "description": "| System message. Allowed values: `true`, `false`. Default is `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Show link previews. Allowed values: `true`, `false`. Default is `true` ||" }, "replyId": { "type": "integer", "description": "| ID of the message being replied to by the bot ||" }, "templateId": { "type": "string", "description": "| UUID of the message template ||" }, "forwardIds": { "type": "object", "description": "| Messages to forward. Format: `{uuid: messageId}`, where `uuid` is an arbitrary UUID string as the key, `messageId` is the ID of the original message. In the response, `uuidMap` will return `{uuid: newMessageId}`." } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.Message.update": { "post": { "summary": "Update Message imbot.v2.Chat.Message.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.Message.update` updates a bot's message. A bot can only update its own messages. Messages sent with the parameter `system: true` cannot be updated—they have `authorId = 0` and do not belong to the bot in terms of access permissions.", "operationId": "imbot_v2_Chat_Message_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/messages/chat-message-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the message to be updated ||" }, "fields": { "type": "object", "description": "| Fields of the message to be updated. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| New text of the message. Maximum length—20,000 characters ||" }, "attach": { "type": "array", "items": {}, "description": "| New attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| New keyboard. More details: Working with keyboards. To remove the keyboard, pass `\"N\"` ||" }, "urlPreview": { "type": "string", "description": "| Show link previews. Acceptable values: `Y`, `N`. Default is `Y` ||" } }, "required": [ "botId", "messageId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "messageId": { "type": "integer", "description": "| ID of the message to be updated ||" }, "fields": { "type": "object", "description": "| Fields of the message to be updated. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| New text of the message. Maximum length—20,000 characters ||" }, "attach": { "type": "array", "items": {}, "description": "| New attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| New keyboard. More details: Working with keyboards. To remove the keyboard, pass `\"N\"` ||" }, "urlPreview": { "type": "string", "description": "| Show link previews. Acceptable values: `Y`, `N`. Default is `Y` ||" } }, "required": [ "botId", "messageId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.TextField.enabled": { "post": { "summary": "Managing the Text Input Field imbot.v2.Chat.TextField.enabled", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.TextField.enabled` enables or disables the text input field in the chat. This method works in both group and personal chats with the bot. Access is verified based on the bot's membership in the chat, so `ACCESS_DENIED` is returned only if the bot is not a participant in the specified dialogue.", "operationId": "imbot_v2_Chat_TextField_enabled", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/ui/chat-text-field-enabled.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialogue ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "enabled": { "type": "boolean", "description": "| Control the input field: `true` — enable, `false` — disable. Default is `true` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialogue ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "enabled": { "type": "boolean", "description": "| Control the input field: `true` — enable, `false` — disable. Default is `true` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.add": { "post": { "summary": "Add Participants to Chat imbot.v2.Chat.User.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.add` adds participants to a chat. The bot must be an administrator of the chat. Non-existent or inactive users will be ignored without an error.", "operationId": "imbot_v2_Chat_User_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to add ||" } }, "required": [ "botId", "dialogId", "userIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userIds": { "type": "string", "description": "| Array of user IDs to add ||" } }, "required": [ "botId", "dialogId", "userIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.delete": { "post": { "summary": "Remove a Participant from the Chat imbot.v2.Chat.User.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.delete` removes a participant from the chat. The bot must be an administrator of the chat. If the user is not a participant in the chat, the method will return `true` (idempotent behavior).", "operationId": "imbot_v2_Chat_User_delete", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| User ID to be removed ||" } }, "required": [ "botId", "dialogId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| User ID to be removed ||" } }, "required": [ "botId", "dialogId", "userId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.User.list": { "post": { "summary": "List of Chat Participants imbot.v2.Chat.User.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.User.list` returns a list of chat participants.", "operationId": "imbot_v2_Chat_User_list", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-user-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "order": { "type": "object", "description": "| Sorting." }, "limit": { "type": "integer", "description": "| Number of records (1–200). Default is `50` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "order": { "type": "object", "description": "| Sorting." }, "limit": { "type": "integer", "description": "| Number of records (1–200). Default is `50` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.add": { "post": { "summary": "Create a Group Chat imbot.v2.Chat.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.add` creates a new group chat on behalf of the bot. If the owner is not specified, the bot becomes the owner.", "operationId": "imbot_v2_Chat_add", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Properties of the chat being created. The structure of the object is described below ||" }, "title": { "type": "string", "description": "| Chat title ||" }, "description": { "type": "string", "description": "| Chat description ||" }, "color": { "type": "string", "description": "| Chat color — available colors." }, "avatar": { "type": "string", "description": "| Chat avatar in Base64 format ||" }, "userIds": { "type": "string", "description": "| Array of participant IDs ||" }, "ownerId": { "type": "integer", "description": "| ID of the chat owner. If not specified, the bot becomes the owner ||" }, "message": { "type": "string", "description": "| First message in the chat ||" }, "Code": { "type": "string", "description": "| HEX ||" } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Properties of the chat being created. The structure of the object is described below ||" }, "title": { "type": "string", "description": "| Chat title ||" }, "description": { "type": "string", "description": "| Chat description ||" }, "color": { "type": "string", "description": "| Chat color — available colors." }, "avatar": { "type": "string", "description": "| Chat avatar in Base64 format ||" }, "userIds": { "type": "string", "description": "| Array of participant IDs ||" }, "ownerId": { "type": "integer", "description": "| ID of the chat owner. If not specified, the bot becomes the owner ||" }, "message": { "type": "string", "description": "| First message in the chat ||" }, "Code": { "type": "string", "description": "| HEX ||" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.get": { "post": { "summary": "Get Information About the Chat imbot.v2.Chat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.get` returns information about the chat. The bot must be a participant in the chat.", "operationId": "imbot_v2_Chat_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.leave": { "post": { "summary": "Leave Chat imbot.v2.Chat.leave", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.leave` removes the bot from the chat.", "operationId": "imbot_v2_Chat_leave", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-leave.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" } }, "required": [ "botId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" } }, "required": [ "botId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.setOwner": { "post": { "summary": "Assign Chat Owner imbot.v2.Chat.setOwner", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.setOwner` transfers ownership of the chat to another user. Only the current owner of the chat can transfer ownership.", "operationId": "imbot_v2_Chat_setOwner", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-set-owner.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID of the new chat owner ||" } }, "required": [ "botId", "dialogId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}` ||" }, "userId": { "type": "integer", "description": "| ID of the new chat owner ||" } }, "required": [ "botId", "dialogId", "userId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Chat.update": { "post": { "summary": "Update Chat Properties imbot.v2.Chat.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Chat.update` updates the properties of a chat. It combines the update of the title, description, color, and avatar in a single call.", "operationId": "imbot_v2_Chat_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/chats/chat-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Properties of the chat to be updated. The structure of the object is described below ||" }, "title": { "type": "string", "description": "| New chat title ||" }, "description": { "type": "string", "description": "| New chat description ||" }, "color": { "type": "string", "description": "| Chat color — available colors ||" }, "avatar": { "type": "string", "description": "| New chat avatar in Base64 format ||" }, "Code": { "type": "string", "description": "| HEX ||" } }, "required": [ "botId", "dialogId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Properties of the chat to be updated. The structure of the object is described below ||" }, "title": { "type": "string", "description": "| New chat title ||" }, "description": { "type": "string", "description": "| New chat description ||" }, "color": { "type": "string", "description": "| Chat color — available colors ||" }, "avatar": { "type": "string", "description": "| New chat avatar in Base64 format ||" }, "Code": { "type": "string", "description": "| HEX ||" } }, "required": [ "botId", "dialogId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.answer": { "post": { "summary": "Responding to the imbot.v2.Command.answer Command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `imbot.v2.Command.answer` method sends a bot's response to a slash command invocation. The bot can respond in the chat from which the command originated, even if the bot is not a participant in that chat. Access is granted temporarily based on the command token — `messageId` + `commandId`. If the bot is not a participant in the chat, the message is sent as a system message indicating the bot's name.", "operationId": "imbot_v2_Command_answer", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-answer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" }, "messageId": { "type": "integer", "description": "| Message ID with the command ||" }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Fields of the response message. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| Response text. Maximum length — 20,000 characters ||" }, "attach": { "type": "array", "items": {}, "description": "| Attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Keyboard. More details: Working with keyboards ||" }, "system": { "type": "boolean", "description": "| System message. Allowed values: `true`, `false`. Default is `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Show link previews. Allowed values: `true`, `false`. Default is `true` ||" } }, "required": [ "botId", "commandId", "messageId", "dialogId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" }, "messageId": { "type": "integer", "description": "| Message ID with the command ||" }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| Fields of the response message. The structure of the object is described below ||" }, "message": { "type": "string", "description": "| Response text. Maximum length — 20,000 characters ||" }, "attach": { "type": "array", "items": {}, "description": "| Attachments. More details: How to use attachments ||" }, "keyboard": { "type": "array", "items": {}, "description": "| Keyboard. More details: Working with keyboards ||" }, "system": { "type": "boolean", "description": "| System message. Allowed values: `true`, `false`. Default is `false` ||" }, "urlPreview": { "type": "boolean", "description": "| Show link previews. Allowed values: `true`, `false`. Default is `true` ||" } }, "required": [ "botId", "commandId", "messageId", "dialogId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.list": { "post": { "summary": "Get the List of Commands imbot.v2.Command.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.list` returns a list of all commands of the bot.", "operationId": "imbot_v2_Command_list", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.register": { "post": { "summary": "Register the Team imbot.v2.Command.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.register` registers a bot's slash command. The method is idempotent: a repeated call with the same `command` for the same bot from the same application returns the existing command without updating the data. To update, use [imbot.v2.Command.update](./command-update.md). The method call format has changed: command parameters are now passed in the `fields` object. The old flat format will be supported until 30.09.2026. For more details, see [API Change Log for imbot.v2](../../change-log.md#command-register-fields).", "operationId": "imbot_v2_Command_register", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Object with command parameters (detailed description) ||" }, "command": { "type": "string", "description": "| Command without the `/` symbol. For example: `help` ||" }, "title": { "type": "object", "description": "| Title of the command in different languages. An object `{langCode: text}`, where `langCode` is a two-letter lowercase language code: `en`, `de`, etc." }, "params": { "type": "object", "description": "| Description of command parameters in different languages. An object `{langCode: text}`, similar to `title`. Displayed as a hint next to the command ||" }, "common": { "type": "boolean", "description": "| Common command. Acceptable values: `true`, `false`. Default is `false`. For more details, see Common and Local Commands ||" }, "hidden": { "type": "boolean", "description": "| Hidden command. Acceptable values: `true`, `false`. Default is `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Extranet support. Acceptable values: `true`, `false`. Default is `false` ||" } }, "required": [ "botId", "fields", "command" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fields": { "type": "object", "description": "| Object with command parameters (detailed description) ||" }, "command": { "type": "string", "description": "| Command without the `/` symbol. For example: `help` ||" }, "title": { "type": "object", "description": "| Title of the command in different languages. An object `{langCode: text}`, where `langCode` is a two-letter lowercase language code: `en`, `de`, etc." }, "params": { "type": "object", "description": "| Description of command parameters in different languages. An object `{langCode: text}`, similar to `title`. Displayed as a hint next to the command ||" }, "common": { "type": "boolean", "description": "| Common command. Acceptable values: `true`, `false`. Default is `false`. For more details, see Common and Local Commands ||" }, "hidden": { "type": "boolean", "description": "| Hidden command. Acceptable values: `true`, `false`. Default is `false` ||" }, "extranetSupport": { "type": "boolean", "description": "| Extranet support. Acceptable values: `true`, `false`. Default is `false` ||" } }, "required": [ "botId", "fields", "command" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.unregister": { "post": { "summary": "Remove the imbot.v2.Command.unregister Command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.unregister` removes a bot's slash command.", "operationId": "imbot_v2_Command_unregister", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" } }, "required": [ "botId", "commandId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" } }, "required": [ "botId", "commandId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Command.update": { "post": { "summary": "Update the imbot.v2.Command.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Command.update` updates the bot's slash command.", "operationId": "imbot_v2_Command_update", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/commands/command-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" }, "fields": { "type": "object", "description": "| Fields of the command to be updated. The structure of the object is described below ||" }, "command": { "type": "string", "description": "| New command (without `/`) ||" }, "title": { "type": "object", "description": "| Title of the command in different languages:" }, "params": { "type": "object", "description": "| Description of parameters in different languages. Similar to `title`, applies only to those languages provided in `title` ||" }, "common": { "type": "string", "description": "| Common command. Allowed values: `Y`, `N` ||" }, "hidden": { "type": "string", "description": "| Hidden command. Allowed values: `Y`, `N` ||" }, "extranetSupport": { "type": "string", "description": "| Extranet support. Allowed values: `Y`, `N` ||" } }, "required": [ "botId", "commandId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "commandId": { "type": "integer", "description": "| Command ID ||" }, "fields": { "type": "object", "description": "| Fields of the command to be updated. The structure of the object is described below ||" }, "command": { "type": "string", "description": "| New command (without `/`) ||" }, "title": { "type": "object", "description": "| Title of the command in different languages:" }, "params": { "type": "object", "description": "| Description of parameters in different languages. Similar to `title`, applies only to those languages provided in `title` ||" }, "common": { "type": "string", "description": "| Common command. Allowed values: `Y`, `N` ||" }, "hidden": { "type": "string", "description": "| Hidden command. Allowed values: `Y`, `N` ||" }, "extranetSupport": { "type": "string", "description": "| Extranet support. Allowed values: `Y`, `N` ||" } }, "required": [ "botId", "commandId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Event.get": { "post": { "summary": "Get Events from imbot.v2.Event.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Event.get` retrieves events for the bot in polling agent mode. It is used for bots with `eventMode: \"fetch\"`. The method confirms the receipt of events with IDs less than the provided `offset`. On the next call, only new events starting from the confirmed ones are returned. Only one application—the one that registered the bot—can receive events for a specific bot. If multiple independent agents are needed, register a separate bot for each.", "operationId": "imbot_v2_Event_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/events/event-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "offset": { "type": "integer", "description": "| Confirms all events with IDs less than the specified value. Not passed on the first call ||" }, "limit": { "type": "integer", "description": "| Maximum number of events returned (1–1000). Default is `100` ||" }, "withUserEvents": { "type": "boolean", "description": "| Include user events (`ONIMV2*`) in the response along with bot events. Default is `false`. More details — below ||" } }, "required": [ "botId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "offset": { "type": "integer", "description": "| Confirms all events with IDs less than the specified value. Not passed on the first call ||" }, "limit": { "type": "integer", "description": "| Maximum number of events returned (1–1000). Default is `100` ||" }, "withUserEvents": { "type": "boolean", "description": "| Include user events (`ONIMV2*`) in the response along with bot events. Default is `false`. More details — below ||" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.File.download": { "post": { "summary": "Get Download Link for imbot.v2.File.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.File.download` returns a link to download a file from the chat.", "operationId": "imbot_v2_File_download", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fileId": { "type": "integer", "description": "| File ID on Drive. Can be obtained from the response of the imbot.v2.File.upload method ||" } }, "required": [ "botId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "fileId": { "type": "integer", "description": "| File ID on Drive. Can be obtained from the response of the imbot.v2.File.upload method ||" } }, "required": [ "botId", "fileId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.File.upload": { "post": { "summary": "Upload File to Chat imbot.v2.File.upload", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.File.upload` uploads a file to the chat on behalf of the bot. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.", "operationId": "imbot_v2_File_upload", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/files/file-upload.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| File and message data. The structure is described below ||" }, "name": { "type": "string", "description": "| File name with extension ||" }, "content": { "type": "string", "description": "| File content in Base64 encoding. Maximum size — 100 MB ||" }, "message": { "type": "string", "description": "| Text message sent along with the file ||" } }, "required": [ "botId", "dialogId", "fields", "name", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "botId": { "type": "integer", "description": "| Bot ID ||" }, "botToken": { "type": "string", "description": "| Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth." }, "dialogId": { "type": "string", "description": "| Dialog ID. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||" }, "fields": { "type": "object", "description": "| File and message data. The structure is described below ||" }, "name": { "type": "string", "description": "| File name with extension ||" }, "content": { "type": "string", "description": "| File content in Base64 encoding. Maximum size — 100 MB ||" }, "message": { "type": "string", "description": "| Text message sent along with the file ||" } }, "required": [ "botId", "dialogId", "fields", "name", "content" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imbot.v2.Revision.get": { "post": { "summary": "Get API Revisions imbot.v2.Revision.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.v2.Revision.get` returns the revision numbers of the REST API and client protocols of the messenger. It is used to check compatibility: which methods and features are supported by a specific Bitrix24.", "operationId": "imbot_v2_Revision_get", "tags": [ "Chatbots" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/imbot.v2/revision-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imbot" ] } ] } }, "/imconnector.activate": { "post": { "summary": "Activate Connector imconnector.activate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.activate` activates or deactivates the connector on the specified open line. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_activate", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-activate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| The identifier of the open line." }, "ACTIVE": { "type": "string", "description": "| Activation flag. Any non-empty value enables the connector, while an empty value or `0` disables it." } }, "required": [ "CONNECTOR", "LINE", "ACTIVE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| The identifier of the open line." }, "ACTIVE": { "type": "string", "description": "| Activation flag. Any non-empty value enables the connector, while an empty value or `0` disables it." } }, "required": [ "CONNECTOR", "LINE", "ACTIVE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.chat.name.set": { "post": { "summary": "Set a New Chat Name imconnector.chat.name.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.chat.name.set` sets a new name for the chat. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_chat_name_set", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-chat-name-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the Open Channel" }, "CHAT_ID": { "type": "string", "description": "| Identifier of the chat in the external system ||" }, "NAME": { "type": "string", "description": "| New name for the chat ||" }, "USER_ID": { "type": "string", "description": "| User identifier. This parameter is mandatory only for connectors without group chats from the external side. For such a connector, the `CHAT_GROUP` parameter in the imconnector.register method must be set to `N` ||" } }, "required": [ "CONNECTOR", "LINE", "CHAT_ID", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the Open Channel" }, "CHAT_ID": { "type": "string", "description": "| Identifier of the chat in the external system ||" }, "NAME": { "type": "string", "description": "| New name for the chat ||" }, "USER_ID": { "type": "string", "description": "| User identifier. This parameter is mandatory only for connectors without group chats from the external side. For such a connector, the `CHAT_GROUP` parameter in the imconnector.register method must be set to `N` ||" } }, "required": [ "CONNECTOR", "LINE", "CHAT_ID", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imconnector" ] } ] } }, "/imconnector.connector.data.set": { "post": { "summary": "Set Connector Settings imconnector.connector.data.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.connector.data.set` sets the channel settings in an external system for a custom connector and the specified open line. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_connector_data_set", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-connector-data-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "DATA": { "type": "object", "description": "| Object containing the channel settings in the external system. The method does not support setting or modifying a single field separately: settings are written and overwritten through this object as a whole." }, "ID": { "type": "string", "description": "| Identifier of the channel in the external system, for example `channel-123`." }, "URL": { "type": "string", "description": "| Full link to the chat or channel in the external system ||" }, "URL_IM": { "type": "string", "description": "| Full link to the chat in the operator interface format. If there is no separate link for the operator, use the value of `URL` ||" }, "NAME": { "type": "string", "description": "| Name of the channel for display in the interface ||" } }, "required": [ "CONNECTOR", "LINE", "DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "DATA": { "type": "object", "description": "| Object containing the channel settings in the external system. The method does not support setting or modifying a single field separately: settings are written and overwritten through this object as a whole." }, "ID": { "type": "string", "description": "| Identifier of the channel in the external system, for example `channel-123`." }, "URL": { "type": "string", "description": "| Full link to the chat or channel in the external system ||" }, "URL_IM": { "type": "string", "description": "| Full link to the chat in the operator interface format. If there is no separate link for the operator, use the value of `URL` ||" }, "NAME": { "type": "string", "description": "| Name of the channel for display in the interface ||" } }, "required": [ "CONNECTOR", "LINE", "DATA" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.delete.messages": { "post": { "summary": "Delete Sent Messages imconnector.delete.messages", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.delete.messages` removes messages from an open line that were sent by an external system. The method works only in the context of an [application](../../../settings/app-installation/index.md). The method parameters use values from the external system: user ID, message ID, and chat or channel ID.", "operationId": "imconnector_delete_messages", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-delete-messages.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of messages to delete. Each element of the array is a message object with three required blocks: `user`, `message`, `chat`. The structure of the object is described in detail below ||" }, "user": { "type": "object", "description": "| User data from the external system." }, "message": { "type": "object", "description": "| Message data from the external system." }, "chat": { "type": "object", "description": "| Chat or channel data from the external system." }, "id": { "type": "string", "description": "| User ID in the external system." } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of messages to delete. Each element of the array is a message object with three required blocks: `user`, `message`, `chat`. The structure of the object is described in detail below ||" }, "user": { "type": "object", "description": "| User data from the external system." }, "message": { "type": "object", "description": "| Message data from the external system." }, "chat": { "type": "object", "description": "| Chat or channel data from the external system." }, "id": { "type": "string", "description": "| User ID in the external system." } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.list": { "post": { "summary": "Get the List of Connectors imconnector.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.list` returns a list of all connectors registered in Bitrix24. The method works only in the context of an [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_list", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.register": { "post": { "summary": "Register the Connector imconnector.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.register` registers a custom connector for Open Channels. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_register", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Unique identifier for the connector. The method converts the value to lowercase. It is recommended to add a unique prefix at the beginning of the identifier to avoid conflicts with existing and future identifiers of other connectors. Use digits, lowercase letters, and the underscore `_` to form..." }, "NAME": { "type": "string", "description": "| Name of the connector in the interface ||" }, "ICON": { "type": "object", "description": "| Parameters for the main icon." }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the embedding handler for the connector settings. At this address, Bitrix24 opens the settings interface in a slider for the user. Read more about embedding interfaces in the article Widget Embedding Mechanism ||" }, "ICON_DISABLED": { "type": "object", "description": "| Parameters for the inactive state icon." }, "DEL_EXTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows deleting incoming messages. Default value is `true` ||" }, "EDIT_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows editing operator messages. Default value is `true` ||" }, "DEL_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows deleting operator messages. Default value is `true` ||" }, "NEWSLETTER": { "type": "boolean", "description": "| Allows using the channel in CRM newsletters. Default value is `true` ||" }, "NEED_SYSTEM_MESSAGES": { "type": "boolean", "description": "| Allows sending system messages to the channel. Default value is `true` ||" }, "NEED_SIGNATURE": { "type": "boolean", "description": "| Adds the operator's signature to messages. Default value is `true` ||" }, "CHAT_GROUP": { "type": "boolean", "description": "| Indicates the chat processing mode of the connector: `true` — grouping by `chat.id` (group chat), `false` — by `user.id` (one-on-one chat). Default value is `false` ||" }, "DATA_IMAGE": { "type": "string", "description": "| SVG icon in Data URI format: a string with the prefix `data:image/svg+xml,`, followed by the SVG content, usually URL-encoded ||" }, "COLOR": { "type": "string", "description": "| Background color of the icon. Example: `#69acc0` ||" }, "SIZE": { "type": "string", "description": "| Background size. Example: `90%` ||" }, "POSITION": { "type": "string", "description": "| Background position. Example: `center` ||" } }, "required": [ "ID", "NAME", "ICON", "PLACEMENT_HANDLER", "DATA_IMAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Unique identifier for the connector. The method converts the value to lowercase. It is recommended to add a unique prefix at the beginning of the identifier to avoid conflicts with existing and future identifiers of other connectors. Use digits, lowercase letters, and the underscore `_` to form..." }, "NAME": { "type": "string", "description": "| Name of the connector in the interface ||" }, "ICON": { "type": "object", "description": "| Parameters for the main icon." }, "PLACEMENT_HANDLER": { "type": "string", "description": "| URL of the embedding handler for the connector settings. At this address, Bitrix24 opens the settings interface in a slider for the user. Read more about embedding interfaces in the article Widget Embedding Mechanism ||" }, "ICON_DISABLED": { "type": "object", "description": "| Parameters for the inactive state icon." }, "DEL_EXTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows deleting incoming messages. Default value is `true` ||" }, "EDIT_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows editing operator messages. Default value is `true` ||" }, "DEL_INTERNAL_MESSAGES": { "type": "boolean", "description": "| Allows deleting operator messages. Default value is `true` ||" }, "NEWSLETTER": { "type": "boolean", "description": "| Allows using the channel in CRM newsletters. Default value is `true` ||" }, "NEED_SYSTEM_MESSAGES": { "type": "boolean", "description": "| Allows sending system messages to the channel. Default value is `true` ||" }, "NEED_SIGNATURE": { "type": "boolean", "description": "| Adds the operator's signature to messages. Default value is `true` ||" }, "CHAT_GROUP": { "type": "boolean", "description": "| Indicates the chat processing mode of the connector: `true` — grouping by `chat.id` (group chat), `false` — by `user.id` (one-on-one chat). Default value is `false` ||" }, "DATA_IMAGE": { "type": "string", "description": "| SVG icon in Data URI format: a string with the prefix `data:image/svg+xml,`, followed by the SVG content, usually URL-encoded ||" }, "COLOR": { "type": "string", "description": "| Background color of the icon. Example: `#69acc0` ||" }, "SIZE": { "type": "string", "description": "| Background size. Example: `90%` ||" }, "POSITION": { "type": "string", "description": "| Background position. Example: `center` ||" } }, "required": [ "ID", "NAME", "ICON", "PLACEMENT_HANDLER", "DATA_IMAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.messages": { "post": { "summary": "Send Messages to Bitrix24 imconnector.send.messages", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.send.messages` accepts messages from an external system and forwards them to an open line in Bitrix24 via a custom connector. The method parameters utilize values from the external system: user ID, chat ID, chat link, and its name in the application that registered the connector. Upon execution, the method returns the chat ID and the open line dialog ID created in Bitrix24.", "operationId": "imconnector_send_messages", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-send-messages.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| The ID of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| An array of messages. Each element of the array represents a single message in the object format with three required blocks: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| User data from the external system." }, "message": { "type": "object", "description": "| Message data from the external system." }, "chat": { "type": "object", "description": "| Chat data from the external system." }, "id": { "type": "string", "description": "| User ID in the external system. The value is generated on the side of the external system ||" }, "last_name": { "type": "string", "description": "| User's last name ||" }, "name": { "type": "string", "description": "| User's first name ||" }, "picture": { "type": "object", "description": "| User's avatar. Pass it as an object with the `url` field, for example, `{\"url\":\"https://example.com/u42.png\"}`. The link must be public ||" }, "url": { "type": "string", "description": "| Link to the user's profile in the external system ||" }, "gender": { "type": "string", "description": "| User's gender. Supported values are `male` and `female` ||" }, "email": { "type": "string", "description": "| User's email ||" }, "phone": { "type": "string", "description": "| User's phone ||" }, "skip_phone_validate": { "type": "string", "description": "| Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter ||" }, "date": { "type": "integer", "description": "| Message time in Unix Timestamp in seconds ||" }, "text": { "type": "string", "description": "| Message text. You must pass either the `text` or `files` element." }, "files": { "type": "array", "items": {}, "description": "| An array of files. Each file is passed as an array of the form `array('url' => 'File link', 'name' => 'File name')`. The `url` link must be accessible from Bitrix24." }, "disable_crm": { "type": "string", "description": "| Disables the CRM tracker for the message. Acceptable value is `Y`. If the CRM tracker should work, do not pass this parameter ||" }, "user_id": { "type": "integer", "description": "| The ID of the manager in Bitrix24. If you pass `user_id`, the message will be sent on behalf of this manager ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| The ID of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| An array of messages. Each element of the array represents a single message in the object format with three required blocks: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| User data from the external system." }, "message": { "type": "object", "description": "| Message data from the external system." }, "chat": { "type": "object", "description": "| Chat data from the external system." }, "id": { "type": "string", "description": "| User ID in the external system. The value is generated on the side of the external system ||" }, "last_name": { "type": "string", "description": "| User's last name ||" }, "name": { "type": "string", "description": "| User's first name ||" }, "picture": { "type": "object", "description": "| User's avatar. Pass it as an object with the `url` field, for example, `{\"url\":\"https://example.com/u42.png\"}`. The link must be public ||" }, "url": { "type": "string", "description": "| Link to the user's profile in the external system ||" }, "gender": { "type": "string", "description": "| User's gender. Supported values are `male` and `female` ||" }, "email": { "type": "string", "description": "| User's email ||" }, "phone": { "type": "string", "description": "| User's phone ||" }, "skip_phone_validate": { "type": "string", "description": "| Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter ||" }, "date": { "type": "integer", "description": "| Message time in Unix Timestamp in seconds ||" }, "text": { "type": "string", "description": "| Message text. You must pass either the `text` or `files` element." }, "files": { "type": "array", "items": {}, "description": "| An array of files. Each file is passed as an array of the form `array('url' => 'File link', 'name' => 'File name')`. The `url` link must be accessible from Bitrix24." }, "disable_crm": { "type": "string", "description": "| Disables the CRM tracker for the message. Acceptable value is `Y`. If the CRM tracker should work, do not pass this parameter ||" }, "user_id": { "type": "integer", "description": "| The ID of the manager in Bitrix24. If you pass `user_id`, the message will be sent on behalf of this manager ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.status.delivery": { "post": { "summary": "Update Status \"Delivered\" imconnector.send.status.delivery", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.send.status.delivery` confirms in Bitrix24 that an outgoing message from an open line has been successfully delivered to an external system. This method does not resend the message; it only records the delivery result. In the current implementation of open lines, when processing the \"delivered\" status, the message is also marked as \"read.\" The method is not applicable for incoming messages from an external system to an open line.", "operationId": "imconnector_send_status_delivery", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-send-status-delivery.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of delivery statuses. Each element of the array is an object with blocks `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Internal identifiers of the message in Bitrix24 (detailed description) ||" }, "message": { "type": "object", "description": "| Message data in the external system (detailed description) ||" }, "chat": { "type": "object", "description": "| Chat data in the external system (detailed description) ||" }, "chat_id": { "type": "integer", "description": "| Identifier of the open line chat in Bitrix24 for the outgoing message ||" }, "message_id": { "type": "integer", "description": "| Identifier of the message in Bitrix24 for which the delivery status needs to be set ||" }, "id": { "type": "array", "items": {}, "description": "| Array of external message identifiers for which the delivery status is being sent. Even for a single message, pass an array, e.g., `[\"ext-msg-1007\"]` ||" }, "date": { "type": "integer", "description": "| Delivery time of the message in Unix Timestamp in seconds ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of delivery statuses. Each element of the array is an object with blocks `im`, `message`, `chat`." }, "im": { "type": "object", "description": "| Internal identifiers of the message in Bitrix24 (detailed description) ||" }, "message": { "type": "object", "description": "| Message data in the external system (detailed description) ||" }, "chat": { "type": "object", "description": "| Chat data in the external system (detailed description) ||" }, "chat_id": { "type": "integer", "description": "| Identifier of the open line chat in Bitrix24 for the outgoing message ||" }, "message_id": { "type": "integer", "description": "| Identifier of the message in Bitrix24 for which the delivery status needs to be set ||" }, "id": { "type": "array", "items": {}, "description": "| Array of external message identifiers for which the delivery status is being sent. Even for a single message, pass an array, e.g., `[\"ext-msg-1007\"]` ||" }, "date": { "type": "integer", "description": "| Delivery time of the message in Unix Timestamp in seconds ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.send.status.reading": { "post": { "summary": "Update Status to \"Read\" imconnector.send.status.reading", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. - The method is hidden because it is essentially useless; the onReceivedStatusReading handler is a stub that simply returns true; The method `imconnector.send.status.reading` confirms in Bitrix24 that an outgoing message from the open line has been read in an external system. The method does not resend the message but only records the read status. This method is not applicable for incoming messages from an external system to the open line.", "operationId": "imconnector_send_status_reading", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-send-status-reading.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of read statuses. Each element of the array is an object with blocks `im`, `message`, `chat`" }, "im": { "type": "object", "description": "| Internal message identifiers in Bitrix24 (detailed description) ||" }, "message": { "type": "object", "description": "| Message data in the external system (detailed description) ||" }, "chat": { "type": "object", "description": "| Chat data in the external system (detailed description) ||" }, "chat_id": { "type": "integer", "description": "| Identifier of the open line chat in Bitrix24 for the outgoing message ||" }, "message_id": { "type": "integer", "description": "| Identifier of the message in Bitrix24 for which the \"read\" status needs to be set ||" }, "id": { "type": "array", "items": {}, "description": "| Array of external message identifiers for which the read status is being sent. Even for a single message, an array should be sent, for example, `[\"ext-msg-1007\"]` ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of read statuses. Each element of the array is an object with blocks `im`, `message`, `chat`" }, "im": { "type": "object", "description": "| Internal message identifiers in Bitrix24 (detailed description) ||" }, "message": { "type": "object", "description": "| Message data in the external system (detailed description) ||" }, "chat": { "type": "object", "description": "| Chat data in the external system (detailed description) ||" }, "chat_id": { "type": "integer", "description": "| Identifier of the open line chat in Bitrix24 for the outgoing message ||" }, "message_id": { "type": "integer", "description": "| Identifier of the message in Bitrix24 for which the \"read\" status needs to be set ||" }, "id": { "type": "array", "items": {}, "description": "| Array of external message identifiers for which the read status is being sent. Even for a single message, an array should be sent, for example, `[\"ext-msg-1007\"]` ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.status": { "post": { "summary": "Get the Status of the Connector imconnector.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.status` returns the current status of the connector for the specified open line. The method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_status", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "string", "description": "| The identifier of the open line ||" } }, "required": [ "CONNECTOR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| The string code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "string", "description": "| The identifier of the open line ||" } }, "required": [ "CONNECTOR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.unregister": { "post": { "summary": "Unregister the Connector imconnector.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.unregister` removes a user connector. This method works only in the context of the [application](../../../settings/app-installation/index.md).", "operationId": "imconnector_unregister", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| The identifier of the connector that was provided during registration in imconnector.register ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| The identifier of the connector that was provided during registration in imconnector.register ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imconnector.update.messages": { "post": { "summary": "Update Sent Messages with imconnector.update.messages", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imconnector.update.messages` updates the data of previously sent messages from an external system in an open line. The method works only in the context of an [application](../../../settings/app-installation/index.md). The method parameters use values from the external system: user ID, chat ID, chat link, and its name in the application that registered the connector.", "operationId": "imconnector_update_messages", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/imconnector/imconnector-update-messages.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of messages to update. Each element of the array is a single message in the object format with three required blocks: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Data of the user from the external system." }, "message": { "type": "object", "description": "| Data of the message from the external system." }, "chat": { "type": "object", "description": "| Data of the chat from the external system." }, "id": { "type": "string", "description": "| User ID in the external system ||" }, "last_name": { "type": "string", "description": "| User's last name ||" }, "name": { "type": "string", "description": "| User's first name ||" }, "picture": { "type": "object", "description": "| User's avatar in the object format with a `url` field, for example `{\"url\":\"https://example.com/u42.png\"}` ||" }, "url": { "type": "string", "description": "| Link to the user's profile in the external system ||" }, "gender": { "type": "string", "description": "| User's gender. Supported values are `male` and `female` ||" }, "email": { "type": "string", "description": "| User's email ||" }, "phone": { "type": "string", "description": "| User's phone ||" }, "skip_phone_validate": { "type": "string", "description": "| Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter ||" }, "date": { "type": "integer", "description": "| Message time in Unix Timestamp in seconds ||" }, "text": { "type": "string", "description": "| New text of the message. Pass either `text` or `files`" }, "files": { "type": "array", "items": {}, "description": "| Array of files. Each file is passed as an array like `array('url' => 'File link', 'name' => 'File name')` ||" }, "disable_crm": { "type": "string", "description": "| Disables the CRM tracker for the message. Acceptable value is `Y` ||" }, "user_id": { "type": "integer", "description": "| ID of the manager in Bitrix24. If `user_id` is passed, the message will be updated on behalf of this manager ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONNECTOR": { "type": "string", "description": "| String code of the connector specified in the `ID` parameter when calling imconnector.register ||" }, "LINE": { "type": "integer", "description": "| Identifier of the open line." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of messages to update. Each element of the array is a single message in the object format with three required blocks: `user`, `message`, `chat`." }, "user": { "type": "object", "description": "| Data of the user from the external system." }, "message": { "type": "object", "description": "| Data of the message from the external system." }, "chat": { "type": "object", "description": "| Data of the chat from the external system." }, "id": { "type": "string", "description": "| User ID in the external system ||" }, "last_name": { "type": "string", "description": "| User's last name ||" }, "name": { "type": "string", "description": "| User's first name ||" }, "picture": { "type": "object", "description": "| User's avatar in the object format with a `url` field, for example `{\"url\":\"https://example.com/u42.png\"}` ||" }, "url": { "type": "string", "description": "| Link to the user's profile in the external system ||" }, "gender": { "type": "string", "description": "| User's gender. Supported values are `male` and `female` ||" }, "email": { "type": "string", "description": "| User's email ||" }, "phone": { "type": "string", "description": "| User's phone ||" }, "skip_phone_validate": { "type": "string", "description": "| Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter ||" }, "date": { "type": "integer", "description": "| Message time in Unix Timestamp in seconds ||" }, "text": { "type": "string", "description": "| New text of the message. Pass either `text` or `files`" }, "files": { "type": "array", "items": {}, "description": "| Array of files. Each file is passed as an array like `array('url' => 'File link', 'name' => 'File name')` ||" }, "disable_crm": { "type": "string", "description": "| Disables the CRM tracker for the message. Acceptable value is `Y` ||" }, "user_id": { "type": "integer", "description": "| ID of the manager in Bitrix24. If `user_id` is passed, the message will be updated on behalf of this manager ||" } }, "required": [ "CONNECTOR", "LINE", "MESSAGES", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.finish": { "post": { "summary": "Finish Dialog imopenlines.bot.session.finish", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.bot.session.finish` ends the current dialog of the open line on behalf of the application's chat-bot.", "operationId": "imopenlines_bot_session_finish", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-finish.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat whose dialog needs to be finished." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat whose dialog needs to be finished." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is required only for webhooks." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.message.send": { "post": { "summary": "Send an Automatic Message in the imopenlines.bot.session.message.send Dialog", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.bot.session.message.send` sends an automatic message from the application chatbot to the open line dialog.", "operationId": "imopenlines_bot_session_message_send", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-message-send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat to which the method sends the message." }, "NAME": { "type": "string", "description": "| The code for the auto-response type." }, "MESSAGE": { "type": "string", "description": "| The message text for the `NAME=DEFAULT` mode. By default, an empty string is used." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat to which the method sends the message." }, "NAME": { "type": "string", "description": "| The code for the auto-response type." }, "MESSAGE": { "type": "string", "description": "| The message text for the `NAME=DEFAULT` mode. By default, an empty string is used." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.operator": { "post": { "summary": "Switch Dialog to Free Operator imopenlines.bot.session.operator", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.bot.session.operator` switches the dialog from the chatbot to a free operator in the open line.", "operationId": "imopenlines_bot_session_operator", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-operator.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat to be passed to the free operator." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat to be passed to the free operator." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.bot.session.transfer": { "post": { "summary": "Transfer a Dialogue to an Operator or Queue using imopenlines.bot.session.transfer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.bot.session.transfer` transfers a dialogue from the chat bot in an open line to a specified operator or queue.", "operationId": "imopenlines_bot_session_transfer", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chat-bots/imopenlines-bot-session-transfer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat whose dialogue needs to be transferred." }, "USER_ID": { "type": "integer", "description": "| The identifier of the employee to whom the dialogue should be transferred." }, "QUEUE_ID": { "type": "integer", "description": "| The identifier of the queue to which the dialogue should be transferred." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Universal transfer destination parameter." }, "LEAVE": { "type": "boolean", "description": "| Flag indicating the presence of the chat bot in the dialogue after the transfer." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is mandatory only for webhooks." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the chat whose dialogue needs to be transferred." }, "USER_ID": { "type": "integer", "description": "| The identifier of the employee to whom the dialogue should be transferred." }, "QUEUE_ID": { "type": "integer", "description": "| The identifier of the queue to which the dialogue should be transferred." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Universal transfer destination parameter." }, "LEAVE": { "type": "boolean", "description": "| Flag indicating the presence of the chat bot in the dialogue after the transfer." }, "CLIENT_ID": { "type": "string", "description": "| This parameter is mandatory only for webhooks." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.add": { "post": { "summary": "Add Open Channel imopenlines.config.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.add` adds a new open channel. To allow users to write to the open channel, set the connector settings using the method [imconnector.connector.data.set](../imconnector/imconnector-connector-data-set.md).", "operationId": "imopenlines_config_add", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Object with open channel settings (detailed description) ||" }, "LINE_NAME": { "type": "string", "description": "| Name of the open channel ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Channel activity. Possible values:" }, "QUEUE_TYPE": { "type": "string", "description": "| Request distribution mode. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Object with open channel settings (detailed description) ||" }, "LINE_NAME": { "type": "string", "description": "| Name of the open channel ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Channel activity. Possible values:" }, "QUEUE_TYPE": { "type": "string", "description": "| Request distribution mode. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.delete": { "post": { "summary": "Delete Open Channel imopenlines.config.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.delete` removes an open channel.", "operationId": "imopenlines_config_delete", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the open channel." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the open channel." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.get": { "post": { "summary": "Get Open Line by ID imopenlines.config.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.get` retrieves the settings of an open line by its ID.", "operationId": "imopenlines_config_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| The ID of the open line." }, "WITH_QUEUE": { "type": "string", "maxLength": 1, "description": "| Return operator queue data. Possible values:" }, "SHOW_OFFLINE": { "type": "string", "maxLength": 1, "description": "| Return offline operators in the queue. Possible values:" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| The ID of the open line." }, "WITH_QUEUE": { "type": "string", "maxLength": 1, "description": "| Return operator queue data. Possible values:" }, "SHOW_OFFLINE": { "type": "string", "maxLength": 1, "description": "| Return offline operators in the queue. Possible values:" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.list.get": { "post": { "summary": "Get the List of Open Channels imopenlines.config.list.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.list.get` retrieves a list of open channels.", "operationId": "imopenlines_config_list_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-list-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Selection parameters (detailed description)" }, "OPTIONS": { "type": "object", "description": "| Additional options (detailed description) ||" }, "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected." }, "order": { "type": "object", "description": "| An object for sorting the list of open channels in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "filter": { "type": "object", "description": "| An object for filtering the list of open channels in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "limit": { "type": "integer", "description": "| The number of items per page. Default: `50`. Maximum value: `200` ||" }, "offset": { "type": "integer", "description": "| Offset for pagination. Default: `0` ||" }, "QUEUE": { "type": "string", "maxLength": 1, "description": "| Return the operator queue. Possible values:" }, "CONFIG_QUEUE": { "type": "string", "maxLength": 1, "description": "| Return the line queue. Each queue element contains `ENTITY_TYPE` and `ENTITY_ID`. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Selection parameters (detailed description)" }, "OPTIONS": { "type": "object", "description": "| Additional options (detailed description) ||" }, "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected." }, "order": { "type": "object", "description": "| An object for sorting the list of open channels in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "filter": { "type": "object", "description": "| An object for filtering the list of open channels in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`" }, "limit": { "type": "integer", "description": "| The number of items per page. Default: `50`. Maximum value: `200` ||" }, "offset": { "type": "integer", "description": "| Offset for pagination. Default: `0` ||" }, "QUEUE": { "type": "string", "maxLength": 1, "description": "| Return the operator queue. Possible values:" }, "CONFIG_QUEUE": { "type": "string", "maxLength": 1, "description": "| Return the line queue. Each queue element contains `ENTITY_TYPE` and `ENTITY_ID`. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.path.get": { "post": { "summary": "Get Link to Public Page of Open Channels imopenlines.config.path.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.path.get` retrieves the link to the public page of open channels on the account.", "operationId": "imopenlines_config_path_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-path-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.config.update": { "post": { "summary": "Update Open Channel imopenlines.config.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.config.update` updates an open channel.", "operationId": "imopenlines_config_update", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-config-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the open channel." }, "PARAMS": { "type": "object", "description": "| Object with settings for the update. The set of fields corresponds to the PARAMS parameter of the `imopenlines.config.add` method ||" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the open channel." }, "PARAMS": { "type": "object", "description": "| Object with settings for the update. The set of fields corresponds to the PARAMS parameter of the `imopenlines.config.add` method ||" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.get": { "post": { "summary": "Get Chats for CRM Object imopenlines.crm.chat.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.chat.get` retrieves a list of chats associated with a CRM object.", "operationId": "imopenlines_crm_chat_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM object. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM object." }, "ACTIVE_ONLY": { "type": "string", "maxLength": 1, "description": "| Flag to return only active chats. Possible values:" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM object. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM object." }, "ACTIVE_ONLY": { "type": "string", "maxLength": 1, "description": "| Flag to return only active chats. Possible values:" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.getLastId": { "post": { "summary": "Get the Id of the Last Chat imopenlines.crm.chat.getLastId", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.chat.getLastId` retrieves the identifier of the last chat associated with the CRM entity.", "operationId": "imopenlines_crm_chat_getLastId", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-get-last-id.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.user.add": { "post": { "summary": "Add User to Existing Chat imopenlines.crm.chat.user.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.chat.user.add` adds a user to a chat associated with a CRM entity.", "operationId": "imopenlines_crm_chat_user_add", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user or bot to be added to the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user or bot to be added to the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.chat.user.delete": { "post": { "summary": "Remove User from Chat imopenlines.crm.chat.user.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.chat.user.delete` removes a user from the chat associated with the CRM entity.", "operationId": "imopenlines_crm_chat_user_delete", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/chats/imopenlines-crm-chat-user-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user or bot to be removed from the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity. Possible values:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user or bot to be removed from the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the chat." } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.lead.create": { "post": { "summary": "Create a Lead Based on the Dialogue imopenlines.crm.lead.create", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.lead.create` creates a CRM lead based on the current chat in the Open Channels.", "operationId": "imopenlines_crm_lead_create", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-crm-lead-create.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the Open Channels chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the Open Channels chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.crm.message.add": { "post": { "summary": "Send a Message to Open Channel imopenlines.crm.message.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.crm.message.add` sends a message on behalf of an employee or bot in a chat linked to a CRM entity.", "operationId": "imopenlines_crm_message_add", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/messages/imopenlines-crm-message-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of the CRM entity:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity linked to the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the message sender — user or bot, who must be a participant in the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the open channel chat linked to the CRM entity." }, "MESSAGE": { "type": "string", "description": "| The text of the message that will be displayed in the chat ||" } }, "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": "| Type of the CRM entity:" }, "CRM_ENTITY": { "type": "integer", "description": "| Identifier of the CRM entity linked to the chat." }, "USER_ID": { "type": "integer", "description": "| Identifier of the message sender — user or bot, who must be a participant in the chat." }, "CHAT_ID": { "type": "integer", "description": "| Identifier of the open channel chat linked to the CRM entity." }, "MESSAGE": { "type": "string", "description": "| The text of the message that will be displayed in the chat ||" } }, "required": [ "CRM_ENTITY_TYPE", "CRM_ENTITY", "USER_ID", "CHAT_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.dialog.get": { "post": { "summary": "Get Information About the Operator's Dialog imopenlines.dialog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.dialog.get` returns data from the open line chat. You only need to provide one of the parameters.", "operationId": "imopenlines_dialog_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-dialog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format `chat`, where `` is the identifier of the open line chat. ||" }, "SESSION_ID": { "type": "integer", "description": "| Identifier of the session." }, "USER_CODE": { "type": "string", "description": "| String code of the user for the external system channel." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "DIALOG_ID": { "type": "string", "description": "| Identifier of the dialog in the format `chat`, where `` is the identifier of the open line chat. ||" }, "SESSION_ID": { "type": "integer", "description": "| Identifier of the session." }, "USER_CODE": { "type": "string", "description": "| String code of the user for the external system channel." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.message.quick.save": { "post": { "summary": "Save Message as Quick Answer imopenlines.message.quick.save", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.message.quick.save` saves a message from the open line chat to the list of quick answers.", "operationId": "imopenlines_message_quick_save", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/messages/imopenlines-message-quick-save.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat from which the message needs to be saved." }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message to be added to quick answers." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat from which the message needs to be saved." }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message to be added to quick answers." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.message.session.start": { "post": { "summary": "Start a New Dialogue Based on the Message imopenlines.message.session.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.message.session.start` initiates a new session and transfers the specified message into it.", "operationId": "imopenlines_message_session_start", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-message-session-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message within the chat." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "MESSAGE_ID": { "type": "integer", "description": "| Identifier of the message within the chat." } }, "required": [ "CHAT_ID", "MESSAGE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.network.join": { "post": { "summary": "Connect an External Open Channel to the Account imopenlines.network.join", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.network.join` connects an external open channel from another Bitrix24 to the current Bitrix24.", "operationId": "imopenlines_network_join", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-network-join.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The code of the open channel as a string of 32 characters." } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The code of the open channel as a string of 32 characters." } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.network.message.add": { "post": { "summary": "Send a message to a user on behalf of the Open Channel imopenlines.network.message.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.network.message.add` sends a message to a user on behalf of the open channel connected in Bitrix24 Network. Method operation limitations: 1. The method is unavailable during session authorization. It returns the error `WRONG_AUTH_TYPE` for session authorization.", "operationId": "imopenlines_network_message_add", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-network-message-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Code of the open channel, a string of 32 characters, for example `ab515f5d85a8b844d484f6ea75a2e494` ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the message recipient, for example `2` ||" }, "MESSAGE": { "type": "string", "description": "| Text of the message." }, "ATTACH": { "type": "object", "description": "| Attachment." }, "KEYBOARD": { "type": "object", "description": "| Keyboard." }, "URL_PREVIEW": { "type": "string", "maxLength": 1, "description": "| Link preview. Enabled `Y` by default." } }, "required": [ "CODE", "USER_ID", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Code of the open channel, a string of 32 characters, for example `ab515f5d85a8b844d484f6ea75a2e494` ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the message recipient, for example `2` ||" }, "MESSAGE": { "type": "string", "description": "| Text of the message." }, "ATTACH": { "type": "object", "description": "| Attachment." }, "KEYBOARD": { "type": "object", "description": "| Keyboard." }, "URL_PREVIEW": { "type": "string", "maxLength": 1, "description": "| Link preview. Enabled `Y` by default." } }, "required": [ "CODE", "USER_ID", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.another.finish": { "post": { "summary": "Finish Another Operator's Dialog imopenlines.operator.another.finish", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.another.finish` ends a dialog in an open line, even if the dialog is assigned to another operator.", "operationId": "imopenlines_operator_another_finish", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-another-finish.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.answer": { "post": { "summary": "Take the dialog for yourself imopenlines.operator.answer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.answer` assigns the dialog of the open line to the current operator.", "operationId": "imopenlines_operator_answer", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-answer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.finish": { "post": { "summary": "Finish Your Dialogue imopenlines.operator.finish", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.finish` ends the open line dialogue on behalf of the current operator.", "operationId": "imopenlines_operator_finish", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-finish.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.skip": { "post": { "summary": "Skip Dialog imopenlines.operator.skip", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.skip` transfers the current dialog to the next operator in the queue.", "operationId": "imopenlines_operator_skip", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-skip.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.spam": { "post": { "summary": "Mark a conversation as \"spam\" imopenlines.operator.spam", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.spam` marks an open line conversation as spam and ends it.", "operationId": "imopenlines_operator_spam", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-spam.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.operator.transfer": { "post": { "summary": "Transfer a dialog to another operator or to another line imopenlines.operator.transfer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.operator.transfer` transfers a dialog to another operator or to the queue of another open line.", "operationId": "imopenlines_operator_transfer", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/operators/imopenlines-operator-transfer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Universal parameter for transferring the dialog." }, "USER_ID": { "type": "integer", "description": "| Identifier of the operator to whom the dialog should be transferred." }, "QUEUE_ID": { "type": "integer", "description": "| Identifier of the line to which the dialog should be transferred." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "TRANSFER_ID": { "type": "string", "description": "\\|`integer` | Universal parameter for transferring the dialog." }, "USER_ID": { "type": "integer", "description": "| Identifier of the operator to whom the dialog should be transferred." }, "QUEUE_ID": { "type": "integer", "description": "| Identifier of the line to which the dialog should be transferred." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.revision.get": { "post": { "summary": "Get Information About API Revisions imopenlines.revision.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.revision.get` retrieves information about the API revisions of Open Channels.", "operationId": "imopenlines_revision_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/imopenlines-revision-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.head.vote": { "post": { "summary": "Rate Employee Performance in the imopenlines.session.head.vote Dialog", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.head.vote` saves the manager's rating and comment for a completed dialog.", "operationId": "imopenlines_session_head_vote", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-head-vote.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Session identifier." }, "RATING": { "type": "integer", "description": "| Manager's rating. Pass a value from `1` to `5` ||" }, "COMMENT": { "type": "string", "description": "| Manager's comment on the rating ||" } }, "required": [ "SESSION_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Session identifier." }, "RATING": { "type": "integer", "description": "| Manager's rating. Pass a value from `1` to `5` ||" }, "COMMENT": { "type": "string", "description": "| Manager's comment on the rating ||" } }, "required": [ "SESSION_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.history.get": { "post": { "summary": "Get Message History of the Dialogue imopenlines.session.history.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.history.get` returns the message history of an open line session.", "operationId": "imopenlines_session_history_get", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-history-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Identifier of the open line session." }, "CHAT_ID": { "type": "integer", "description": "| Numeric identifier of the open line chat without the `chat` prefix. For example, `1763`, not `chat1763`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SESSION_ID": { "type": "integer", "description": "| Identifier of the open line session." }, "CHAT_ID": { "type": "integer", "description": "| Numeric identifier of the open line chat without the `chat` prefix. For example, `1763`, not `chat1763`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.intercept": { "post": { "summary": "Take Over the Dialogue from the Current Operator imopenlines.session.intercept", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.intercept` transfers the current dialogue to the operator who calls the method.", "operationId": "imopenlines_session_intercept", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-intercept.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.join": { "post": { "summary": "Join the Dialogue imopenlines.session.join", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.join` adds the current operator to an active dialogue in the Open Channels.", "operationId": "imopenlines_session_join", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-join.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the Open Channels chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the Open Channels chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.pin": { "post": { "summary": "Pin or Unpin a Dialog imopenlines.session.mode.pin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.mode.pin` pins or unpins a dialog to the current operator.", "operationId": "imopenlines_session_mode_pin", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "ACTIVATE": { "type": "string", "description": "| Pinning flag:" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "ACTIVATE": { "type": "string", "description": "| Pinning flag:" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.pinAll": { "post": { "summary": "Pin All Available Dialogs to the Operator imopenlines.session.mode.pinAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.mode.pinAll` pins all available active dialogs to the current operator.", "operationId": "imopenlines_session_mode_pinAll", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-pin-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.silent": { "post": { "summary": "Switch the dialog to silent mode imopenlines.session.mode.silent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.mode.silent` enables or disables the silent messaging mode in the dialog. The development of this method has been halted, but it continues to function.", "operationId": "imopenlines_session_mode_silent", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-silent.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "ACTIVATE": { "type": "string", "description": "| Activation flag. `Y` — enable silent mode, any other value disables it. By default, the mode is off ||" } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| Identifier of the open line chat." }, "ACTIVATE": { "type": "string", "description": "| Activation flag. `Y` — enable silent mode, any other value disables it. By default, the mode is off ||" } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.mode.unpinAll": { "post": { "summary": "Unpin All Operator Dialogs imopenlines.session.mode.unpinAll", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.mode.unpinAll` unpins all available pinned dialogs from the current operator.", "operationId": "imopenlines_session_mode_unpinAll", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-mode-unpin-all.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.open": { "post": { "summary": "Get Chat by User Code imopenlines.session.open", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.open` returns the chat ID of the open line based on the user code `USER_CODE`.", "operationId": "imopenlines_session_open", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-open.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_CODE": { "type": "string", "description": "| String code of the user for the external system channel." } }, "required": [ "USER_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_CODE": { "type": "string", "description": "| String code of the user for the external system channel." } }, "required": [ "USER_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/imopenlines.session.start": { "post": { "summary": "Start a New Dialogue imopenlines.session.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imopenlines.session.start` initiates a new session in the current open line chat.", "operationId": "imopenlines_session_start", "tags": [ "Open Lines" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/imopenlines/openlines/sessions/imopenlines-session-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CHAT_ID": { "type": "integer", "description": "| The identifier of the open line chat." } }, "required": [ "CHAT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "imopenlines" ] } ] } }, "/landing.block.addcard": { "post": { "summary": "Add Card to Block landing.block.addcard", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.addcard` adds a card to a block in the draft of a page. This method works with cards described in the `cards` key of the block manifest. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_addcard", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-add-card.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the key `cards` of the block manifest" }, "content": { "type": "string", "description": "| HTML of the new card." }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the key `cards` of the block manifest" }, "content": { "type": "string", "description": "| HTML of the new card." }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector", "content" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.changeAnchor": { "post": { "summary": "Change the Anchor of the Block landing.block.changeAnchor", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.changeAnchor` modifies or removes a custom anchor of a block in the draft of a page. If the page is already published, changes will be visible to visitors after publishing the updates through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).", "operationId": "landing_block_changeAnchor", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-anchor.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "data": { "type": "string", "description": "| New anchor of the block without the `#` symbol." }, "preventHistory": { "type": "boolean", "description": "| Do not add the change to the page history." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "data": { "type": "string", "description": "| New anchor of the block without the `#` symbol." }, "preventHistory": { "type": "boolean", "description": "| Do not add the change to the page history." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.changeNodeName": { "post": { "summary": "Change HTML Tag of a Block Element landing.block.changeNodeName", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.changeNodeName` changes the HTML tag of a block element in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).", "operationId": "landing_block_changeNodeName", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-node-name.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page" }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page" }, "data": { "type": "object", "description": "| Set of changes for block elements (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If `true` is passed, the method will not add the action to the page change history" }, "Value": { "type": "string", "description": "| Description ||" } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page" }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page" }, "data": { "type": "object", "description": "| Set of changes for block elements (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If `true` is passed, the method will not add the action to the page change history" }, "Value": { "type": "string", "description": "| Description ||" } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.clonecard": { "post": { "summary": "Clone Card of Block landing.block.clonecard", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.clonecard` creates a copy of a card in the block within the draft of the page. It works with cards described in the `cards` key of the block manifest. If the page is already published, the changes will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_clonecard", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-clone-card.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the cards key of the block manifest." }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the cards key of the block manifest." }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getContentFromRepository": { "post": { "summary": "Get Block Content from Repository landing.block.getContentFromRepository", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getContentFromRepository` returns the HTML content of a block from the repository.", "operationId": "landing_block_getContentFromRepository", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content-from-repository.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| The code of the block whose content needs to be retrieved." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| The code of the block whose content needs to be retrieved." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getbyid": { "post": { "summary": "Get Block by ID landing.block.getbyid", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getbyid` returns a single block of a page by its identifier.", "operationId": "landing_block_getbyid", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-by-id.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "block": { "type": "integer", "description": "| Block identifier." }, "params": { "type": "object", "description": "| Additional parameters for reading the block (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the method reads the draft version of the page instead of the published version." }, "deleted": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the method searches for blocks marked as deleted." }, "get_content": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the `result` additionally returns the fields `content`, `css`, and `js`." } }, "required": [ "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "block": { "type": "integer", "description": "| Block identifier." }, "params": { "type": "object", "description": "| Additional parameters for reading the block (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the method reads the draft version of the page instead of the published version." }, "deleted": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the method searches for blocks marked as deleted." }, "get_content": { "type": "boolean", "description": "\\| `integer` | If set to `true`, the `result` additionally returns the fields `content`, `css`, and `js`." } }, "required": [ "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getcontent": { "post": { "summary": "Get Content of Block landing.block.getcontent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getcontent` returns the ready HTML of the block, its resources, manifest, and service properties of the block.", "operationId": "landing_block_getcontent", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier." }, "editMode": { "type": "boolean", "description": "| Mode for obtaining the version of the block." }, "params": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "wrapper_show": { "type": "boolean", "description": "| Whether to return the external container of the block `
` in `result.content`." }, "force_unactive": { "type": "boolean", "description": "| Generate HTML even for inactive blocks." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier." }, "editMode": { "type": "boolean", "description": "| Mode for obtaining the version of the block." }, "params": { "type": "object", "description": "| Additional parameters (detailed description) ||" }, "wrapper_show": { "type": "boolean", "description": "| Whether to return the external container of the block `
` in `result.content`." }, "force_unactive": { "type": "boolean", "description": "| Generate HTML even for inactive blocks." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getlist": { "post": { "summary": "Get the List of Page Blocks landing.block.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getlist` returns a list of blocks for the selected page.", "operationId": "landing_block_getlist", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope for landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "\\| [`integer[]`](../../../data-types.md) | Identifier of the page or an array of page identifiers." }, "params": { "type": "object", "description": "| Additional parameters for reading the list (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method reads the draft version of the page instead of the published version." }, "deleted": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method returns only blocks marked as deleted." }, "get_content": { "type": "boolean", "description": "\\| `integer` | If `true` is passed, the method will add the `content`, `css`, and `js` fields to each result element. By default — `false`." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope for landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "\\| [`integer[]`](../../../data-types.md) | Identifier of the page or an array of page identifiers." }, "params": { "type": "object", "description": "| Additional parameters for reading the list (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method reads the draft version of the page instead of the published version." }, "deleted": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method returns only blocks marked as deleted." }, "get_content": { "type": "boolean", "description": "\\| `integer` | If `true` is passed, the method will add the `content`, `css`, and `js` fields to each result element. By default — `false`." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getmanifest": { "post": { "summary": "Get the Manifest of the landing.block.getmanifest Method", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `landing.block.getmanifest` method returns a prepared manifest of the block placed on the page. It does not return the original file but rather the prepared data for a specific block. For example, localized titles, fields such as `code`, `preview`, `assets`, `timestamp`, and `callbacks`.", "operationId": "landing_block_getmanifest", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier. The block must belong to the page `lid` in the selected version of the page." }, "params": { "type": "object", "description": "| Additional parameters for reading the manifest (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method reads the draft of the page instead of the published version. Default is `false`." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier. The block must belong to the page `lid` in the selected version of the page." }, "params": { "type": "object", "description": "| Additional parameters for reading the manifest (detailed description) ||" }, "edit_mode": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the method reads the draft of the page instead of the published version. Default is `false`." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getmanifestfile": { "post": { "summary": "Get the Manifest File of the Block landing.block.getmanifestfile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getmanifestfile` returns the original manifest of the block from the file repository. Unlike [landing.block.getmanifest](./landing-block-get-manifest.md), this method returns the manifest in its original form — as specified in the `.description.php` file. It does not add any service fields, such as `code`, `preview`, or `timestamp`.", "operationId": "landing_block_getmanifestfile", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| The code of the block from the file repository." } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| The code of the block from the file repository." } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.getrepository": { "post": { "summary": "Get a List of Blocks from the Repository landing.block.getrepository", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getrepository` returns the available sections of the block repository or the data for a specific section.", "operationId": "landing_block_getrepository", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-repository.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "section": { "type": "string", "description": "| The code of the repository section, for example `text`." }, "scope": { "type": "string", "description": "| An additional top-level parameter of the REST call that affects the type of site for which the repository is being collected." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "section": { "type": "string", "description": "| The code of the repository section, for example `text`." }, "scope": { "type": "string", "description": "| An additional top-level parameter of the REST call that affects the type of site for which the repository is being collected." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.removecard": { "post": { "summary": "Remove Card from Block landing.block.removecard", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.removecard` removes a card from a block in the draft of a page. This method only works with cards described in the `cards` key of the block manifest. If the page is already published, the change will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_removecard", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-remove-card.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the cards section of the block manifest" }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "selector": { "type": "string", "description": "| Selector of the card from the cards section of the block manifest" }, "preventHistory": { "type": "boolean", "description": "| Do not add the action to the page change history." } }, "required": [ "lid", "block", "selector" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateCards": { "post": { "summary": "Update Cards in landing.block.updateCards", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateCards` updates a set of cards in a block and the nodes within those cards in the draft of the page. This method works with cards described in the `cards` key of the block manifest. If the page is already published, changes will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_updateCards", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-cards.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "data": { "type": "object", "description": "| Set of changes for the block cards (detailed description) ||" }, "source": { "type": "array", "items": {}, "description": "| Defines the final order and number of cards (detailed description) ||" }, "values": { "type": "array", "items": {}, "description": "| Updates nodes within cards after applying `source` (detailed description) ||" }, "type": { "type": "string", "description": "| Type of the card source." }, "value": { "type": "integer", "description": "\\| `string` | Value of the card source." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the draft of the page." }, "data": { "type": "object", "description": "| Set of changes for the block cards (detailed description) ||" }, "source": { "type": "array", "items": {}, "description": "| Defines the final order and number of cards (detailed description) ||" }, "values": { "type": "array", "items": {}, "description": "| Updates nodes within cards after applying `source` (detailed description) ||" }, "type": { "type": "string", "description": "| Type of the card source." }, "value": { "type": "integer", "description": "\\| `string` | Value of the card source." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateStyles": { "post": { "summary": "Update Styles for landing.block.updateStyles", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateStyles` updates the CSS classes and inline styles of block elements in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_updateStyles", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-styles.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Object format:" }, "preventHistory": { "type": "boolean", "description": "| If `true` is passed, the method will not add the change to the page history." }, "classList": { "type": "array", "items": {}, "description": "| List of CSS classes for the element after the update." }, "affect": { "type": "array", "items": {}, "description": "| List of CSS properties to be removed from the inline styles of all nested elements of the found node. For example, `[\"text-align\", \"color\"]` ||" }, "style": { "type": "object", "description": "| Set of inline styles for the found element in the format `{ \"css-property\": \"value\" }`. The method merges the passed values with the current `style` attribute." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Object format:" }, "preventHistory": { "type": "boolean", "description": "| If `true` is passed, the method will not add the change to the page history." }, "classList": { "type": "array", "items": {}, "description": "| List of CSS classes for the element after the update." }, "affect": { "type": "array", "items": {}, "description": "| List of CSS properties to be removed from the inline styles of all nested elements of the found node. For example, `[\"text-align\", \"color\"]` ||" }, "style": { "type": "object", "description": "| Set of inline styles for the found element in the format `{ \"css-property\": \"value\" }`. The method merges the passed values with the current `style` attribute." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updateattrs": { "post": { "summary": "Change Attributes of Block Elements landing.block.updateattrs", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateattrs` updates the attributes of HTML elements within a block in the draft of a page. This method does not change the text, the entire HTML code of the block, or styles. It only updates the attribute values of already existing elements, such as `href`, `target`, `alt`, `title`, `data-*`, and `aria-*`. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.", "operationId": "landing_block_updateattrs", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-attrs.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Set of attributes to update (detailed description) ||" } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Set of attributes to update (detailed description) ||" } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updatecontent": { "post": { "summary": "Update Content of the Block landing.block.updatecontent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updatecontent` completely replaces the HTML content of a block in the page draft. If you only need to change specific nodes, attributes, or styles of the block, use the methods [landing.block.updatenodes](./landing-block-update-nodes.md), [landing.block.updateattrs](./landing-block-update-attrs.md), and [landing.block.updateStyles](./landing-block-update-styles.md).", "operationId": "landing_block_updatecontent", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-content.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the page draft." }, "content": { "type": "string", "description": "| New HTML content of the block." }, "designed": { "type": "boolean", "description": "\\| `integer` \\| `string` | Marks the block as manually modified." }, "preventHistory": { "type": "boolean", "description": "| Do not add the change to the page history. Default is `false` ||" } }, "required": [ "lid", "block", "content" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the page draft." }, "content": { "type": "string", "description": "| New HTML content of the block." }, "designed": { "type": "boolean", "description": "\\| `integer` \\| `string` | Marks the block as manually modified." }, "preventHistory": { "type": "boolean", "description": "| Do not add the change to the page history. Default is `false` ||" } }, "required": [ "lid", "block", "content" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.updatenodes": { "post": { "summary": "Update Nodes of the Block landing.block.updatenodes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updatenodes` updates the nodes of a block in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).", "operationId": "landing_block_updatenodes", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-nodes.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Set of changes for the block nodes and component parameters available for editing (detailed description) ||" }, "additional": { "type": "object", "description": "| Additional save parameters (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If set to `true`, the method will not add the action to the page change history. Default is `false` ||" }, "appendMenu": { "type": "boolean", "description": "| Adds new items to the current menu instead of completely replacing it. Works only for blocks that have a `menu` section described in the manifest." } }, "required": [ "lid", "block", "data" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the version of the page for editing." }, "data": { "type": "object", "description": "| Set of changes for the block nodes and component parameters available for editing (detailed description) ||" }, "additional": { "type": "object", "description": "| Additional save parameters (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If set to `true`, the method will not add the action to the page change history. Default is `false` ||" }, "appendMenu": { "type": "boolean", "description": "| Adds new items to the current menu instead of completely replacing it. Works only for blocks that have a `menu` section described in the manifest." } }, "required": [ "lid", "block", "data" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.block.uploadfile": { "post": { "summary": "Upload and Attach an Image to the Block landing.block.uploadfile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.uploadfile` uploads an image and attaches it to the specified block. In response, the method returns the file identifier and a link to it in the `src` field. The method does not insert the image into the block itself. This means that after uploading, the file exists, but it is not yet displayed in the block's content. Typically, after `landing.block.uploadfile`, the [landing.block.updatenodes](./landing-block-update-nodes.md) method is called.", "operationId": "landing_block_uploadfile", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-upload-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "block": { "type": "integer", "description": "| Identifier of the block to which the image needs to be attached." }, "picture": { "type": "string", "description": "\\| [`string[]`](../../../data-types.md) | Image to upload." }, "ext": { "type": "string", "description": "| File extension for uploading via URL, if it cannot be accurately determined from the address." }, "params": { "type": "object", "description": "| Additional parameters for image processing (detailed description)." }, "temp": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the file is marked as temporary." }, "width": { "type": "integer", "description": "| Target width of the image in pixels." }, "height": { "type": "integer", "description": "| Target height of the image in pixels." }, "resize_type": { "type": "integer", "description": "| Resizing mode." } }, "required": [ "block", "picture" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "block": { "type": "integer", "description": "| Identifier of the block to which the image needs to be attached." }, "picture": { "type": "string", "description": "\\| [`string[]`](../../../data-types.md) | Image to upload." }, "ext": { "type": "string", "description": "| File extension for uploading via URL, if it cannot be accurately determined from the address." }, "params": { "type": "object", "description": "| Additional parameters for image processing (detailed description)." }, "temp": { "type": "boolean", "description": "\\| `integer` | If the value is cast to `true`, the file is marked as temporary." }, "width": { "type": "integer", "description": "| Target width of the image in pixels." }, "height": { "type": "integer", "description": "| Target height of the image in pixels." }, "resize_type": { "type": "integer", "description": "| Resizing mode." } }, "required": [ "block", "picture" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getList": { "post": { "summary": "Get a List of Registered Templates landing.demos.getList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getList` retrieves a list of registered templates.", "operationId": "landing_demos_getList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object format:" }, "select": { "type": "string", "description": "| Array format:" }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "group": { "type": "array", "items": {}, "description": "| Array of fields for grouping the result." }, "limit": { "type": "integer", "description": "| Limit on the number of records in the selection ||" }, "offset": { "type": "integer", "description": "| Offset of records in the selection ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object format:" }, "select": { "type": "string", "description": "| Array format:" }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "group": { "type": "array", "items": {}, "description": "| Array of fields for grouping the result." }, "limit": { "type": "integer", "description": "| Limit on the number of records in the selection ||" }, "offset": { "type": "integer", "description": "| Offset of records in the selection ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getPageList": { "post": { "summary": "Get a List of Templates for Creating Pages landing.demos.getPageList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getPageList` retrieves a list of file demo templates for pages.", "operationId": "landing_demos_getPageList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-page-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.getSiteList": { "post": { "summary": "Get a List of Templates for Creating Websites landing.demos.getSiteList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getSiteList` retrieves a list of file demo templates for websites.", "operationId": "landing_demos_getSiteList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-site-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| Object format:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.register": { "post": { "summary": "Register a Template in the Site Creation Wizard landing.demos.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.register` registers a custom template in the site and page creation wizard. The method updates the template if it already exists with the same code for the current application. If it does not exist, it creates a new one.", "operationId": "landing_demos_register", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Additional registration parameters more details ||" }, "charset": { "type": "string", "description": "| Encoding of the exported template ||" }, "site_code": { "type": "string", "description": "| Site code (path) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "description": { "type": "string", "description": "\\| `null` | Template description ||" }, "type": { "type": "string", "description": "| Template type." }, "tpl_type": { "type": "string", "description": "| Template usage type in the wizard." }, "fields": { "type": "object", "description": "| Site fields from the export more details ||" }, "folders": { "type": "array", "items": {}, "description": "\\| `object` | Folders from the export more details ||" }, "items": { "type": "object", "description": "| Map of template pages in the format `{ \"page_code\": items }` more details ||" }, "layout": { "type": "array", "items": {}, "description": "\\| `object` | Layout data from the export more details ||" }, "preview": { "type": "string", "description": "| Link to preview 1x ||" }, "preview2x": { "type": "string", "description": "| Link to preview 2x ||" }, "preview3x": { "type": "string", "description": "| Link to preview 3x ||" }, "preview_url": { "type": "string", "description": "| Link to preview ||" }, "show_in_list": { "type": "string", "description": "| Indicator for display in the list (`Y`/`N`) ||" }, "syspages": { "type": "array", "items": {}, "description": "\\| `object` | System pages from the export more details ||" }, "version": { "type": "integer", "description": "| Version of the export format ||" }, "old_id": { "type": "string", "description": "\\| `integer` | Original page identifier ||" }, "code": { "type": "string", "description": "| Block code ||" }, "access": { "type": "string", "description": "| Access level to the block ||" }, "anchor": { "type": "string", "description": "| Block anchor ||" }, "cards": { "type": "object", "description": "| Block cards ||" }, "nodes": { "type": "object", "description": "| Block nodes ||" }, "style": { "type": "object", "description": "| Block styles ||" }, "attrs": { "type": "object", "description": "| Block attributes ||" }, "site_template_id": { "type": "string", "description": "| Identifier of the site template of the main module." }, "lang": { "type": "object", "description": "| Localization of the main phrases of the template." }, "lang_original": { "type": "string", "description": "| Code of the original language for the `lang` array ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Additional registration parameters more details ||" }, "charset": { "type": "string", "description": "| Encoding of the exported template ||" }, "site_code": { "type": "string", "description": "| Site code (path) ||" }, "name": { "type": "string", "description": "| Template name ||" }, "description": { "type": "string", "description": "\\| `null` | Template description ||" }, "type": { "type": "string", "description": "| Template type." }, "tpl_type": { "type": "string", "description": "| Template usage type in the wizard." }, "fields": { "type": "object", "description": "| Site fields from the export more details ||" }, "folders": { "type": "array", "items": {}, "description": "\\| `object` | Folders from the export more details ||" }, "items": { "type": "object", "description": "| Map of template pages in the format `{ \"page_code\": items }` more details ||" }, "layout": { "type": "array", "items": {}, "description": "\\| `object` | Layout data from the export more details ||" }, "preview": { "type": "string", "description": "| Link to preview 1x ||" }, "preview2x": { "type": "string", "description": "| Link to preview 2x ||" }, "preview3x": { "type": "string", "description": "| Link to preview 3x ||" }, "preview_url": { "type": "string", "description": "| Link to preview ||" }, "show_in_list": { "type": "string", "description": "| Indicator for display in the list (`Y`/`N`) ||" }, "syspages": { "type": "array", "items": {}, "description": "\\| `object` | System pages from the export more details ||" }, "version": { "type": "integer", "description": "| Version of the export format ||" }, "old_id": { "type": "string", "description": "\\| `integer` | Original page identifier ||" }, "code": { "type": "string", "description": "| Block code ||" }, "access": { "type": "string", "description": "| Access level to the block ||" }, "anchor": { "type": "string", "description": "| Block anchor ||" }, "cards": { "type": "object", "description": "| Block cards ||" }, "nodes": { "type": "object", "description": "| Block nodes ||" }, "style": { "type": "object", "description": "| Block styles ||" }, "attrs": { "type": "object", "description": "| Block attributes ||" }, "site_template_id": { "type": "string", "description": "| Identifier of the site template of the main module." }, "lang": { "type": "object", "description": "| Localization of the main phrases of the template." }, "lang_original": { "type": "string", "description": "| Code of the original language for the `lang` array ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.demos.unregister": { "post": { "summary": "Delete Registered Template landing.demos.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.unregister` deletes a registered template by its code.", "operationId": "landing_demos_unregister", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.add": { "post": { "summary": "Add Page or Folder landing.landing.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.add` adds a page or folder to the specified site and returns the identifier of the created object. The new object is created as inactive (`ACTIVE = N`).", "operationId": "landing_landing_add", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "fields": { "type": "object", "description": "| Set of fields for the new page or folder (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the page ||" }, "SITE_ID": { "type": "integer", "description": "| Identifier of the site where the page is created." }, "CODE": { "type": "string", "description": "| Symbolic code of the page. It must not contain the character `/` and must not be in the format `__`, for example `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Arbitrary description of the page ||" }, "XML_ID": { "type": "string", "description": "| External identifier of the page ||" }, "SITEMAP": { "type": "string", "description": "| Flag to include the page in the sitemap. Supported values are `Y` and `N`, default is `N` ||" }, "FOLDER": { "type": "string", "description": "| Used if a folder needs to be created instead of a page. Supported values are `Y` and `N`, default is `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Identifier of the folder where the page should be created. The folder must belong to the same site as `SITE_ID`." }, "TPL_ID": { "type": "integer", "description": "| Identifier of the page view template." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the page. Available codes and values are described in the article Additional Page Fields ||" }, "BLOCK_ID": { "type": "integer", "description": "| Used together with `MENU_CODE` to add a link to the menu of the block with the specified identifier after the page is created ||" }, "MENU_CODE": { "type": "string", "description": "| Used together with `BLOCK_ID` to specify the menu code in the block where the link to the created page should be added ||" } }, "required": [ "fields", "TITLE", "SITE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "fields": { "type": "object", "description": "| Set of fields for the new page or folder (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the page ||" }, "SITE_ID": { "type": "integer", "description": "| Identifier of the site where the page is created." }, "CODE": { "type": "string", "description": "| Symbolic code of the page. It must not contain the character `/` and must not be in the format `__`, for example `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| Arbitrary description of the page ||" }, "XML_ID": { "type": "string", "description": "| External identifier of the page ||" }, "SITEMAP": { "type": "string", "description": "| Flag to include the page in the sitemap. Supported values are `Y` and `N`, default is `N` ||" }, "FOLDER": { "type": "string", "description": "| Used if a folder needs to be created instead of a page. Supported values are `Y` and `N`, default is `N` ||" }, "FOLDER_ID": { "type": "integer", "description": "| Identifier of the folder where the page should be created. The folder must belong to the same site as `SITE_ID`." }, "TPL_ID": { "type": "integer", "description": "| Identifier of the page view template." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the page. Available codes and values are described in the article Additional Page Fields ||" }, "BLOCK_ID": { "type": "integer", "description": "| Used together with `MENU_CODE` to add a link to the menu of the block with the specified identifier after the page is created ||" }, "MENU_CODE": { "type": "string", "description": "| Used together with `BLOCK_ID` to specify the menu code in the block where the link to the created page should be added ||" } }, "required": [ "fields", "TITLE", "SITE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.addByTemplate": { "post": { "summary": "Add Page by Template landing.landing.addByTemplate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.addByTemplate` creates a page in the specified site based on the template code and returns the identifier of the created page. The new page is created as inactive (`ACTIVE = N`). If you need to fully manage the fields of the created page, use [landing.landing.add](./landing-landing-add.md).", "operationId": "landing_landing_addByTemplate", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add-by-template.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site where the page needs to be created." }, "code": { "type": "string", "description": "| Template code for the page." }, "fields": { "type": "object", "description": "| Additional parameters for creating the page (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Overrides the title of the created page and the SEO titles of the template." }, "DESCRIPTION": { "type": "string", "description": "| Overrides the SEO descriptions of the template." }, "ID": { "type": "integer", "description": "| Identifier of an existing page or folder in the same site." }, "FOLDER_ID": { "type": "integer", "description": "| Identifier of the folder where the page needs to be created. The folder must belong to the same site as `siteId`, otherwise the method will return an error." }, "SITE_TYPE": { "type": "string", "description": "| Type of templates from which the page is created. Site types from the article Working with Site Types and Scopes are used." }, "PREPARE_BLOCKS": { "type": "boolean", "description": "| Enables preparation of template blocks when creating the page." }, "PREPARE_BLOCKS_DATA": { "type": "object", "description": "| Additional data for preparing template blocks when creating the page." }, "ADD_IN_MENU": { "type": "string", "description": "| Flag for adding the created page to the site menu. Supported values are `Y` and `N`." }, "BLOCK_ID": { "type": "integer", "description": "| Together with `MENU_CODE`, adds a link to the created page in the menu of the block with the specified identifier ||" }, "MENU_CODE": { "type": "string", "description": "| Together with `BLOCK_ID`, specifies the menu code within the block where the link to the created page should be added ||" }, "ACTION": { "type": "string", "description": "| What needs to be done with the block. The value `changeComponentParams` is supported ||" }, "PARAMS": { "type": "object", "description": "| Component parameters that need to be substituted into the block when creating the page." }, "Parameter": { "type": "string", "description": "| Description ||" } }, "required": [ "siteId", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site where the page needs to be created." }, "code": { "type": "string", "description": "| Template code for the page." }, "fields": { "type": "object", "description": "| Additional parameters for creating the page (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Overrides the title of the created page and the SEO titles of the template." }, "DESCRIPTION": { "type": "string", "description": "| Overrides the SEO descriptions of the template." }, "ID": { "type": "integer", "description": "| Identifier of an existing page or folder in the same site." }, "FOLDER_ID": { "type": "integer", "description": "| Identifier of the folder where the page needs to be created. The folder must belong to the same site as `siteId`, otherwise the method will return an error." }, "SITE_TYPE": { "type": "string", "description": "| Type of templates from which the page is created. Site types from the article Working with Site Types and Scopes are used." }, "PREPARE_BLOCKS": { "type": "boolean", "description": "| Enables preparation of template blocks when creating the page." }, "PREPARE_BLOCKS_DATA": { "type": "object", "description": "| Additional data for preparing template blocks when creating the page." }, "ADD_IN_MENU": { "type": "string", "description": "| Flag for adding the created page to the site menu. Supported values are `Y` and `N`." }, "BLOCK_ID": { "type": "integer", "description": "| Together with `MENU_CODE`, adds a link to the created page in the menu of the block with the specified identifier ||" }, "MENU_CODE": { "type": "string", "description": "| Together with `BLOCK_ID`, specifies the menu code within the block where the link to the created page should be added ||" }, "ACTION": { "type": "string", "description": "| What needs to be done with the block. The value `changeComponentParams` is supported ||" }, "PARAMS": { "type": "object", "description": "| Component parameters that need to be substituted into the block when creating the page." }, "Parameter": { "type": "string", "description": "| Description ||" } }, "required": [ "siteId", "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.addblock": { "post": { "summary": "Add Block to Page landing.landing.addblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.addblock` adds a new block to the page and returns the identifier of the created block. If the page is already published, the new block will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_addblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-add-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "fields": { "type": "object", "description": "| Set of parameters for the new block (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the block from the repository." }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block after which the new block should be inserted." }, "ACTIVE": { "type": "string", "description": "| Flag indicating the activity of the new block. Possible values:" }, "CONTENT": { "type": "string", "description": "| HTML content of the block. Allows replacing the standard content of the block with your own HTML code. The block code must still be available in the repository for the current type of page and `scope`. Before saving, the value is cleaned and validated ||" }, "RETURN_CONTENT": { "type": "string", "description": "| If `Y` is passed, after adding the block, the method will return not only its identifier but also the block data (detailed description). For any other value, the method will return only the block identifier ||" } }, "required": [ "lid", "fields", "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "fields": { "type": "object", "description": "| Set of parameters for the new block (detailed description) ||" }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the block from the repository." }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block after which the new block should be inserted." }, "ACTIVE": { "type": "string", "description": "| Flag indicating the activity of the new block. Possible values:" }, "CONTENT": { "type": "string", "description": "| HTML content of the block. Allows replacing the standard content of the block with your own HTML code. The block code must still be available in the repository for the current type of page and `scope`. Before saving, the value is cleaned and validated ||" }, "RETURN_CONTENT": { "type": "string", "description": "| If `Y` is passed, after adding the block, the method will return not only its identifier but also the block data (detailed description). For any other value, the method will return only the block identifier ||" } }, "required": [ "lid", "fields", "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.copy": { "post": { "summary": "Copy Page landing.landing.copy", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.copy` copies a page and returns the identifier of the new page. This method can also copy a page marked as deleted and located in the trash.", "operationId": "landing_landing_copy", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-copy.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the source page." }, "toSiteId": { "type": "integer", "description": "| Identifier of the target site. If this parameter is not provided or set to `0`, the copy will be created in the same site where the source page is located." }, "toFolderId": { "type": "integer", "description": "| Identifier of the target folder. If this parameter is provided, the copy is created in the specified folder. The folder must belong to the target site `toSiteId`." }, "skipSystem": { "type": "boolean", "description": "| Flag for copying the system attribute of the page. Default is `false`." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the source page." }, "toSiteId": { "type": "integer", "description": "| Identifier of the target site. If this parameter is not provided or set to `0`, the copy will be created in the same site where the source page is located." }, "toFolderId": { "type": "integer", "description": "| Identifier of the target folder. If this parameter is provided, the copy is created in the specified folder. The folder must belong to the target site `toSiteId`." }, "skipSystem": { "type": "boolean", "description": "| Flag for copying the system attribute of the page. Default is `false`." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.copyblock": { "post": { "summary": "Copy Block to Page landing.landing.copyblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.copyblock` copies a block to the specified page and returns the identifier of the created copy of the block. You can copy a block from another page or within the same page. The HTML content of the block is also copied.", "operationId": "landing_landing_copyblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-copy-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to which the block should be copied." }, "block": { "type": "integer", "description": "| Identifier of the source block." }, "params": { "type": "object", "description": "| Additional copy parameters (detailed description) ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block on the page `lid`, after which the copy should be inserted." }, "RETURN_CONTENT": { "type": "string", "description": "| If you pass `Y`, the method will return an object with a success indicator and data of the created copy of the block (detailed description). For any other value, the method will return only the identifier of the created copy of the block ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to which the block should be copied." }, "block": { "type": "integer", "description": "| Identifier of the source block." }, "params": { "type": "object", "description": "| Additional copy parameters (detailed description) ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block on the page `lid`, after which the copy should be inserted." }, "RETURN_CONTENT": { "type": "string", "description": "| If you pass `Y`, the method will return an object with a success indicator and data of the created copy of the block (detailed description). For any other value, the method will return only the identifier of the created copy of the block ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.delete": { "post": { "summary": "Delete Page landing.landing.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.delete` removes a page along with its blocks and associated files.", "operationId": "landing_landing_delete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.deleteblock": { "post": { "summary": "Delete Block from Page landing.landing.deleteblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.deleteblock` completely removes a block from the page. If the page is already published, changes will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md). Along with the block, associated data is deleted. Files and images are marked for deletion and will be automatically removed if they are not used elsewhere.", "operationId": "landing_landing_deleteblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-delete-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.downblock": { "post": { "summary": "Move Block Down landing.landing.downblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.downblock` moves a block one position down in the page draft. If the page is already published, visitors will see the change after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_downblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-down-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier in the editable version of the page." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "block": { "type": "integer", "description": "| Block identifier in the editable version of the page." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.favoriteBlock": { "post": { "summary": "Save to the list of blocks landing.landing.favoriteBlock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.favoriteBlock` creates a copy of a page block and saves it to the block list as a template. Upon successful execution, the method returns the identifier of the new block copy.", "operationId": "landing_landing_favoriteBlock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-favorite-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "meta": { "type": "object", "description": "| Parameters of the saved block (detailed description)." }, "name": { "type": "string", "description": "| Name of the saved block copy in the block list." }, "section": { "type": "array", "items": {}, "description": "\\| `string` | Section or list of sections where the saved block will be displayed. If the parameter is not provided, the block will be shown in the same sections as the original block." }, "preview": { "type": "integer", "description": "| Identifier of the preview image file." }, "tpl_code": { "type": "string", "description": "| Template code of the page to which the saved block should be linked." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "meta": { "type": "object", "description": "| Parameters of the saved block (detailed description)." }, "name": { "type": "string", "description": "| Name of the saved block copy in the block list." }, "section": { "type": "array", "items": {}, "description": "\\| `string` | Section or list of sections where the saved block will be displayed. If the parameter is not provided, the block will be shown in the same sections as the original block." }, "preview": { "type": "integer", "description": "| Identifier of the preview image file." }, "tpl_code": { "type": "string", "description": "| Template code of the page to which the saved block should be linked." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getList": { "post": { "summary": "Get a List of Pages landing.landing.getList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getList` retrieves a list of pages based on the selection parameters. By default, the method returns only pages on non-deleted sites with `DELETED = \"N\"`. To retrieve deleted pages, pass `DELETED` or `=DELETED` in the filter. This only works for pages on non-deleted sites: the method does not return pages from deleted sites.", "operationId": "landing_landing_getList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landings. It is not related to the REST scope `landing` in the method name." }, "params": { "type": "object", "description": "| Parameters for selecting pages (detailed description) ||" }, "select": { "type": "string", "description": "| List of fields to select from Page Object Fields. If the parameter is not passed or is equal to `null`, `[\"*\"]` is used." }, "filter": { "type": "object", "description": "| Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with `.` and `CHECK_PERMISSIONS` are ignored." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC\"}` or `{\"FIELD\": \"DESC\"}`. If the parameter is not passed, no special sorting is applied. ||" }, "group": { "type": "array", "items": {}, "description": "| Grouping in ORM format. The method does not have a default value. ||" }, "limit": { "type": "integer", "description": "| Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit. ||" }, "offset": { "type": "integer", "description": "| Offset for the selection at the ORM level. ||" }, "get_preview": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes a `PREVIEW` field with a link to the page preview. ||" }, "get_urls": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes a `PUBLIC_URL` field with the public address of the page. ||" }, "check_area": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes an `IS_AREA` field indicating whether the page is an included area. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landings. It is not related to the REST scope `landing` in the method name." }, "params": { "type": "object", "description": "| Parameters for selecting pages (detailed description) ||" }, "select": { "type": "string", "description": "| List of fields to select from Page Object Fields. If the parameter is not passed or is equal to `null`, `[\"*\"]` is used." }, "filter": { "type": "object", "description": "| Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with `.` and `CHECK_PERMISSIONS` are ignored." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC\"}` or `{\"FIELD\": \"DESC\"}`. If the parameter is not passed, no special sorting is applied. ||" }, "group": { "type": "array", "items": {}, "description": "| Grouping in ORM format. The method does not have a default value. ||" }, "limit": { "type": "integer", "description": "| Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit. ||" }, "offset": { "type": "integer", "description": "| Offset for the selection at the ORM level. ||" }, "get_preview": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes a `PREVIEW` field with a link to the page preview. ||" }, "get_urls": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes a `PUBLIC_URL` field with the public address of the page. ||" }, "check_area": { "type": "boolean", "description": "\\| `integer` | If the value evaluates to `true`, each result element includes an `IS_AREA` field indicating whether the page is an included area. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getadditionalfields": { "post": { "summary": "Get Additional Fields of the Page landing.landing.getadditionalfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getadditionalfields` retrieves [additional fields](../additional-fields.md) of the page.", "operationId": "landing_landing_getadditionalfields", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-additional-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getpreview": { "post": { "summary": "Get the URL of the Preview for landing.landing.getpreview", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getpreview` returns the URL or relative path to the preview image of the page.", "operationId": "landing_landing_getpreview", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-preview.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.getpublicurl": { "post": { "summary": "Get Public URL of the Page landing.landing.getpublicurl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getpublicurl` returns the complete public URL of the page.", "operationId": "landing_landing_getpublicurl", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.hideblock": { "post": { "summary": "Hide Block on Page landing.landing.hideblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.hideblock` hides a block on the page. The hidden block remains in the draft of the page and can be shown again using the method [landing.landing.showblock](./landing-landing-show-block.md). If the page is already published, the change will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_hideblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-hide-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markDelete": { "post": { "summary": "Mark Page as Deleted landing.landing.markDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markDelete` marks the page as deleted, moves it to the trash, and unpublishes it.", "operationId": "landing_landing_markDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markUnDelete": { "post": { "summary": "Restore Page from Recycle Bin landing.landing.markUnDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markUnDelete` restores a page from the recycle bin and removes the deletion flag. After restoration, the page remains unpublished (`ACTIVE = \"N\"`).", "operationId": "landing_landing_markUnDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-undelete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markdeletedblock": { "post": { "summary": "Mark a Block as Deleted landing.landing.markdeletedblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markdeletedblock` marks a page block as deleted but does not remove it from the database. The marked block can be restored using the method [landing.landing.markundeletedblock](./landing-landing-mark-undeleted-block.md). If the page is already published, changes will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_markdeletedblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "mark": { "type": "boolean", "description": "| Indicator for marking the block as deleted. Default is `true`." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "mark": { "type": "boolean", "description": "| Indicator for marking the block as deleted. Default is `true`." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.markundeletedblock": { "post": { "summary": "Remove the deletion mark from the block landing.landing.markundeletedblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markundeletedblock` removes the deletion mark from the block. If the page is already published, the changes will be visible to visitors after the \"Publish changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md). The method only removes the deletion mark. If the block was hidden before deletion, it will remain hidden after restoration. To show such a block again, use [landing.landing.showblock](./landing-landing-show-block.md).", "operationId": "landing_landing_markundeletedblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.move": { "post": { "summary": "Move Page landing.landing.move", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.move` moves a page to another site or folder.", "operationId": "landing_landing_move", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-move.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to be moved." }, "toSiteId": { "type": "integer", "description": "| Identifier of the destination site." }, "toFolderId": { "type": "integer", "description": "| Identifier of the destination folder in the target site." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to be moved." }, "toSiteId": { "type": "integer", "description": "| Identifier of the destination site." }, "toFolderId": { "type": "integer", "description": "| Identifier of the destination folder in the target site." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.moveblock": { "post": { "summary": "Move Block to Page landing.landing.moveblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.moveblock` moves a block to the specified page and returns the identifier of the moved block. The block can be moved within the same page or to another page. If the pages are already published, changes will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the [landing.landing.publication](../methods/landing-landing-publication.md) method.", "operationId": "landing_landing_moveblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-move-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to which the block needs to be moved." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "params": { "type": "object", "description": "| Additional parameters for the move (detailed description) ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block on the page `lid`, after which the moved block should be placed." }, "RETURN_CONTENT": { "type": "string", "description": "| If set to `Y`, the method will return an object with a success flag and data of the moved block (detailed description). For any other value, the method will return only the identifier of the moved block. ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page to which the block needs to be moved." }, "block": { "type": "integer", "description": "| Identifier of the block." }, "params": { "type": "object", "description": "| Additional parameters for the move (detailed description) ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the block on the page `lid`, after which the moved block should be placed." }, "RETURN_CONTENT": { "type": "string", "description": "| If set to `Y`, the method will return an object with a success flag and data of the moved block (detailed description). For any other value, the method will return only the identifier of the moved block. ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.publication": { "post": { "summary": "Publish the landing.landing.publication page", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.publication` publishes the page and makes it active. If the page is located in a folder, the method will publish that folder and all parent folders. After this, the site will become active. For Knowledge Base pages, the method manages the visibility of the page: making it available or hidden from users.", "operationId": "landing_landing_publication", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-publication.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.removeEntities": { "post": { "summary": "Remove Blocks and Clear Image File Bindings on Page landing.landing.removeEntities", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.removeEntities` removes specified blocks and their associated images from the page. It can also clear file bindings for individual images without deleting the blocks themselves.", "operationId": "landing_landing_removeEntities", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-remove-entities.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "data": { "type": "object", "description": "| Set of objects to be deleted (detailed description)." }, "blocks": { "type": "string", "description": "| Identifiers of the page blocks to be completely removed." }, "images": { "type": "string", "description": "| Pairs of block and image identifiers for deleting file bindings. The content of the block remains unchanged — use this when the image has already been removed from the block and you need to clear the remaining service record. (detailed description)." }, "block": { "type": "integer", "description": "| Identifier of the block associated with the image file binding ||" }, "image": { "type": "integer", "description": "| Internal identifier of the image file binding (`FILE_ID`) associated with the block `block`." } }, "required": [ "lid", "data", "block", "image" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Page identifier." }, "data": { "type": "object", "description": "| Set of objects to be deleted (detailed description)." }, "blocks": { "type": "string", "description": "| Identifiers of the page blocks to be completely removed." }, "images": { "type": "string", "description": "| Pairs of block and image identifiers for deleting file bindings. The content of the block remains unchanged — use this when the image has already been removed from the block and you need to clear the remaining service record. (detailed description)." }, "block": { "type": "integer", "description": "| Identifier of the block associated with the image file binding ||" }, "image": { "type": "integer", "description": "| Internal identifier of the image file binding (`FILE_ID`) associated with the block `block`." } }, "required": [ "lid", "data", "block", "image" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.resolveIdByPublicUrl": { "post": { "summary": "Get Page ID by Public URL landing.landing.resolveIdByPublicUrl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.resolveIdByPublicUrl` returns the page ID based on its public URL within the specified site.", "operationId": "landing_landing_resolveIdByPublicUrl", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "landingUrl": { "type": "string", "description": "| Relative public URL of the page within the site `siteId`, for example `/catalog/sale/`." }, "siteId": { "type": "integer", "description": "| The ID of the site within which to find the page." } }, "required": [ "landingUrl", "siteId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "landingUrl": { "type": "string", "description": "| Relative public URL of the page within the site `siteId`, for example `/catalog/sale/`." }, "siteId": { "type": "integer", "description": "| The ID of the site within which to find the page." } }, "required": [ "landingUrl", "siteId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.showblock": { "post": { "summary": "Show Block on Page landing.landing.showblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.showblock` displays a block on the page that was previously hidden. If the page is already published, changes will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the [landing.landing.publication](../methods/landing-landing-publication.md) method. If the block is marked as deleted, first restore it using the [landing.landing.markundeletedblock](./landing-landing-mark-undeleted-block.md) method.", "operationId": "landing_landing_showblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-show-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.unFavoriteBlock": { "post": { "summary": "Remove from the saved list of blocks landing.landing.unFavoriteBlock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.unFavoriteBlock` removes the saved copy of a block. The original block on the page remains unchanged. When a saved block is deleted, any associated files, such as a user-uploaded preview for that block, are also removed. You can only delete a saved block that the current user created using the method [landing.landing.favoriteBlock](./landing-landing-favorite-block.md).", "operationId": "landing_landing_unFavoriteBlock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "blockId": { "type": "integer", "description": "| Identifier of the saved copy of the block." } }, "required": [ "blockId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "blockId": { "type": "integer", "description": "| Identifier of the saved copy of the block." } }, "required": [ "blockId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.unpublic": { "post": { "summary": "Unpublishing a Page landing.landing.unpublic", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.unpublic` unpublishes a page.", "operationId": "landing_landing_unpublic", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-unpublic.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." } }, "required": [ "lid" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.upblock": { "post": { "summary": "Move Block Up landing.landing.upblock", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.upblock` moves a block one position up in the draft of the page. If the page is already published, the change will be visible to visitors after the \"Publish Changes\" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).", "operationId": "landing_landing_upblock", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-up-block.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "lid": { "type": "integer", "description": "| Identifier of the page." }, "block": { "type": "integer", "description": "| Identifier of the block in the editable version of the page." }, "preventHistory": { "type": "boolean", "description": "| If `true`, the method does not add the action to the page change history. Default is `false` ||" } }, "required": [ "lid", "block" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.landing.update": { "post": { "summary": "Update Page landing.landing.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.update` updates the parameters of the page.", "operationId": "landing_landing_update", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| The identifier of the page to be updated." }, "fields": { "type": "object", "description": "| A set of fields for the page to be updated (detailed description) ||" }, "TITLE": { "type": "string", "description": "| The title of the page. ||" }, "CODE": { "type": "string", "description": "| The symbolic code of the page. The code cannot contain the character `/` and must not be in the format `__`, for example `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| A free-form description of the page. ||" }, "XML_ID": { "type": "string", "description": "| The external identifier of the page. ||" }, "SITE_ID": { "type": "integer", "description": "| The identifier of the site to which the page should be linked. If the parameter is not passed, the current site of the page is used." }, "SITEMAP": { "type": "string", "description": "| A flag to include the page in the sitemap. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||" }, "FOLDER": { "type": "string", "description": "| A folder indicator. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||" }, "FOLDER_ID": { "type": "integer", "description": "| The identifier of the folder in which to place the page. The folder must be within the current site of the page. If `0` is passed, the page will be moved to the root of the site." }, "TPL_ID": { "type": "integer", "description": "| The identifier of the page view template." }, "DELETED": { "type": "string", "description": "| Manages the state of the page in the trash. When this field is passed, the page becomes inactive." }, "DATE_PUBLIC": { "type": "string", "description": "| The date and time of the page publication." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the page. Available codes and values are described in the article Additional Page Fields. ||" } }, "required": [ "lid", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "lid": { "type": "integer", "description": "| The identifier of the page to be updated." }, "fields": { "type": "object", "description": "| A set of fields for the page to be updated (detailed description) ||" }, "TITLE": { "type": "string", "description": "| The title of the page. ||" }, "CODE": { "type": "string", "description": "| The symbolic code of the page. The code cannot contain the character `/` and must not be in the format `__`, for example `code_12_34`." }, "DESCRIPTION": { "type": "string", "description": "| A free-form description of the page. ||" }, "XML_ID": { "type": "string", "description": "| The external identifier of the page. ||" }, "SITE_ID": { "type": "integer", "description": "| The identifier of the site to which the page should be linked. If the parameter is not passed, the current site of the page is used." }, "SITEMAP": { "type": "string", "description": "| A flag to include the page in the sitemap. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||" }, "FOLDER": { "type": "string", "description": "| A folder indicator. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||" }, "FOLDER_ID": { "type": "integer", "description": "| The identifier of the folder in which to place the page. The folder must be within the current site of the page. If `0` is passed, the page will be moved to the root of the site." }, "TPL_ID": { "type": "integer", "description": "| The identifier of the page view template." }, "DELETED": { "type": "string", "description": "| Manages the state of the page in the trash. When this field is passed, the page becomes inactive." }, "DATE_PUBLIC": { "type": "string", "description": "| The date and time of the page publication." }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the page. Available codes and values are described in the article Additional Page Fields. ||" } }, "required": [ "lid", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.checkContent": { "post": { "summary": "Check Content for Dangerous Substrings landing.repo.checkContent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.checkContent` checks content through a sanitizer.", "operationId": "landing_repo_checkContent", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-check-content.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "splitter": { "type": "string", "description": "| A delimiter that marks dangerous fragments in `content`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "splitter": { "type": "string", "description": "| A delimiter that marks dangerous fragments in `content`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.getList": { "post": { "summary": "Get a List of Custom Blocks landing.repo.getList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.getList` retrieves a list of custom blocks.", "operationId": "landing_repo_getList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object format:" }, "select": { "type": "string", "description": "| Array format:" }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "group": { "type": "array", "items": {}, "description": "| Array of fields for grouping the result." }, "limit": { "type": "integer", "description": "| Limit of records ||" }, "offset": { "type": "integer", "description": "| Offset of records ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Object format:" }, "select": { "type": "string", "description": "| Array format:" }, "filter": { "type": "object", "description": "| Object format:" }, "order": { "type": "object", "description": "| Object format:" }, "group": { "type": "array", "items": {}, "description": "| Array of fields for grouping the result." }, "limit": { "type": "integer", "description": "| Limit of records ||" }, "offset": { "type": "integer", "description": "| Offset of records ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.register": { "post": { "summary": "Add a Custom Block to the Repository landing.repo.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.register` adds a new custom block to the repository. The method updates the block if it already exists with the same code for the current application. If it does not exist, it creates a new one.", "operationId": "landing_repo_register", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "manifest": { "type": "object", "description": "| Block manifest." }, "DESCRIPTION": { "type": "string", "description": "| Block description ||" }, "ACTIVE": { "type": "string", "description": "| Block activity (`Y`/`N`) ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding of the block to the site template ||" }, "RESET": { "type": "string", "description": "| If `Y` is passed, the method registers updates for blocks added to pages with the code `repo_` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "manifest": { "type": "object", "description": "| Block manifest." }, "DESCRIPTION": { "type": "string", "description": "| Block description ||" }, "ACTIVE": { "type": "string", "description": "| Block activity (`Y`/`N`) ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding of the block to the site template ||" }, "RESET": { "type": "string", "description": "| If `Y` is passed, the method registers updates for blocks added to pages with the code `repo_` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.unbind": { "post": { "summary": "Remove Embedding Placement landing.repo.unbind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.unbind` removes the embedding placement registered by the current application in the `landing` section.", "operationId": "landing_repo_unbind", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/landing-repo-unbind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "handler": { "type": "string", "description": "| Path of the embedding placement handler." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "handler": { "type": "string", "description": "| Path of the embedding placement handler." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repo.unregister": { "post": { "summary": "Delete User Block landing.repo.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.unregister` deletes a user block by its code.", "operationId": "landing_repo_unregister", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.debug": { "post": { "summary": "Enable Debug Mode landing.repowidget.debug", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repowidget.debug` enables debug mode for all widgets of the current application. In this case, the vue application will report more errors in the js console for developer convenience. By default, the mode is disabled.", "operationId": "landing_repowidget_debug", "tags": [ "Vibe" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vibe/landing-repowidget-debug.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enable": { "type": "boolean", "description": "| Debug mode activation flag ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "enable": { "type": "boolean", "description": "| Debug mode activation flag ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.getlist": { "post": { "summary": "Get the list of widgets landing.repowidget.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repowidget.getlist` returns a list of widgets for the current application, filtered by the specified criteria.", "operationId": "landing_repowidget_getlist", "tags": [ "Vibe" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vibe/landing-repowidget-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Array of fields to retrieve the list of widgets ||" }, "select": { "type": "array", "items": {}, "description": "| Array with the list of fields to be selected." }, "filter": { "type": "object", "description": "| Object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "group": { "type": "array", "items": {}, "description": "| Array for grouping widgets. Grouping can be done by fields of the widget ||" }, "order": { "type": "object", "description": "| Object for sorting the selected records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "ID": { "type": "integer", "description": "| Widget identifier ||" }, "XML_ID": { "type": "string", "description": "| Unique record code ||" }, "APP_CODE": { "type": "string", "description": "| Code of the current application ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Widget activity. Accepts values:" }, "NAME": { "type": "string", "description": "| Widget name ||" }, "DESCRIPTION": { "type": "string", "description": "| Widget description ||" }, "SECTIONS": { "type": "string", "description": "| Code of the section where the widget will be added ||" }, "PREVIEW": { "type": "string", "description": "| URL of the widget cover image for the widget selection slider ||" }, "WIDGET_PARAMS": { "type": "object", "description": "| Parameters for the Vue template engine ||" }, "CONTENT": { "type": "string", "description": "| Widget markup using Vue constructs ||" }, "MANIFEST": { "type": "object", "description": "| Widget manifest ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Identifier of the user who created the record ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Identifier of the user who modified the record ||" }, "DATE_CREATE": { "type": "string", "format": "date", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date", "description": "| Modification date ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding of the widget to a specific site template. Only for on-premise Bitrix24! ||" } }, "required": [ "params" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Array of fields to retrieve the list of widgets ||" }, "select": { "type": "array", "items": {}, "description": "| Array with the list of fields to be selected." }, "filter": { "type": "object", "description": "| Object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "group": { "type": "array", "items": {}, "description": "| Array for grouping widgets. Grouping can be done by fields of the widget ||" }, "order": { "type": "object", "description": "| Object for sorting the selected records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "ID": { "type": "integer", "description": "| Widget identifier ||" }, "XML_ID": { "type": "string", "description": "| Unique record code ||" }, "APP_CODE": { "type": "string", "description": "| Code of the current application ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Widget activity. Accepts values:" }, "NAME": { "type": "string", "description": "| Widget name ||" }, "DESCRIPTION": { "type": "string", "description": "| Widget description ||" }, "SECTIONS": { "type": "string", "description": "| Code of the section where the widget will be added ||" }, "PREVIEW": { "type": "string", "description": "| URL of the widget cover image for the widget selection slider ||" }, "WIDGET_PARAMS": { "type": "object", "description": "| Parameters for the Vue template engine ||" }, "CONTENT": { "type": "string", "description": "| Widget markup using Vue constructs ||" }, "MANIFEST": { "type": "object", "description": "| Widget manifest ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Identifier of the user who created the record ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Identifier of the user who modified the record ||" }, "DATE_CREATE": { "type": "string", "format": "date", "description": "| Creation date ||" }, "DATE_MODIFY": { "type": "string", "format": "date", "description": "| Modification date ||" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding of the widget to a specific site template. Only for on-premise Bitrix24! ||" } }, "required": [ "params" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.register": { "post": { "summary": "Add Widget to Start Page: the Vibe landing.repowidget.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repowidget.register` adds a widget for the Start page: the Vibe. It returns an error or the `ID` of the added widget. During the addition, a check is performed. If a widget with the code `code` has already been registered previously, its content will be updated. Widgets already placed on the Vibe will be automatically updated in case of content changes.", "operationId": "landing_repowidget_register", "tags": [ "Vibe" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vibe/landing-repowidget-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Unique code for the widget. It is highly recommended to use a unique prefix for your widgets to avoid the risk of code conflicts with widgets from other developers ||" }, "fields": { "type": "object", "description": "| Field values for creating the widget ||" }, "NAME": { "type": "string", "description": "| Widget name ||" }, "PREVIEW": { "type": "string", "description": "| URL of the widget cover image for the widget selection slider ||" }, "DESCRIPTION": { "type": "string", "description": "| Widget description ||" }, "CONTENT": { "type": "string", "description": "| Widget markup using Vue constructs ||" }, "SECTIONS": { "type": "string", "description": "| Code of the section where the widget will be added. List of available sections:" }, "WIDGET_PARAMS": { "type": "object", "description": "| Parameters for the Vue templater. If absent, the block will remain as regular HTML code with `{{}}` ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Widget activity. Accepts values:" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding the widget to a specific site template. Only for on-premise Bitrix24! ||" }, "rootNode": { "type": "string", "description": "| Selector for the root element in the markup that will be turned into a Vue component. The root element must be the only element in the passed template; all other markup will be cleared ||" }, "lang": { "type": "string", "description": "| Array of language phrases used in constructs `{{$Bitrix.Loc.getMessage('W_EMPTY')}}` ||" }, "handler": { "type": "string", "description": "| Address of the external handler to which requests will be sent." }, "style": { "type": "string", "description": "| Address of styles for the widget. Styles can also be set inline in the markup via the binding `:style=\"{borderBottom: '1px solid red'}\"` ||" }, "demoData": { "type": "object", "description": "| Demo data for the widget that will be used to showcase the widget in the Vibe templates in Bitrix24 Marketplace." } }, "required": [ "code", "fields", "rootNode", "handler", "demoData" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Unique code for the widget. It is highly recommended to use a unique prefix for your widgets to avoid the risk of code conflicts with widgets from other developers ||" }, "fields": { "type": "object", "description": "| Field values for creating the widget ||" }, "NAME": { "type": "string", "description": "| Widget name ||" }, "PREVIEW": { "type": "string", "description": "| URL of the widget cover image for the widget selection slider ||" }, "DESCRIPTION": { "type": "string", "description": "| Widget description ||" }, "CONTENT": { "type": "string", "description": "| Widget markup using Vue constructs ||" }, "SECTIONS": { "type": "string", "description": "| Code of the section where the widget will be added. List of available sections:" }, "WIDGET_PARAMS": { "type": "object", "description": "| Parameters for the Vue templater. If absent, the block will remain as regular HTML code with `{{}}` ||" }, "ACTIVE": { "type": "string", "maxLength": 1, "description": "| Widget activity. Accepts values:" }, "SITE_TEMPLATE_ID": { "type": "string", "description": "| Binding the widget to a specific site template. Only for on-premise Bitrix24! ||" }, "rootNode": { "type": "string", "description": "| Selector for the root element in the markup that will be turned into a Vue component. The root element must be the only element in the passed template; all other markup will be cleared ||" }, "lang": { "type": "string", "description": "| Array of language phrases used in constructs `{{$Bitrix.Loc.getMessage('W_EMPTY')}}` ||" }, "handler": { "type": "string", "description": "| Address of the external handler to which requests will be sent." }, "style": { "type": "string", "description": "| Address of styles for the widget. Styles can also be set inline in the markup via the binding `:style=\"{borderBottom: '1px solid red'}\"` ||" }, "demoData": { "type": "object", "description": "| Demo data for the widget that will be used to showcase the widget in the Vibe templates in Bitrix24 Marketplace." } }, "required": [ "code", "fields", "rootNode", "handler", "demoData" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.repowidget.unregister": { "post": { "summary": "Unregister Widget for Vibe landing.repowidget.unregister", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repowidget.unregister` removes the widget for Start page: the Vibe. On success, it returns `true`; otherwise, it returns `false` or an error with a description.", "operationId": "landing_repowidget_unregister", "tags": [ "Vibe" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vibe/landing-repowidget-unregister.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Unique code of the widget to be removed ||" } }, "required": [ "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "| Unique code of the widget to be removed ||" } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.enable": { "post": { "summary": "Enable or Disable Role-Based Access Model landing.role.enable", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.enable` enables or disables the role-based access model for the \"Sites and Stores\" section.", "operationId": "landing_role_enable", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/landing-role-enable.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "integer", "description": "| Access model mode. You can check the current model using the landing.role.isEnabled method. Possible values:" } }, "required": [ "mode" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "mode": { "type": "integer", "description": "| Access model mode. You can check the current model using the landing.role.isEnabled method. Possible values:" } }, "required": [ "mode" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.getList": { "post": { "summary": "Get the List of Roles landing.role.getList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.getList` retrieves a list of access roles for the selected type of sites.", "operationId": "landing_role_getList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope `landing` in the method name." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope `landing` in the method name." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.getRights": { "post": { "summary": "Get Role Rights with landing.role.getRights", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.getRights` returns the rights of the specified role for each site where they are configured.", "operationId": "landing_role_getRights", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-get-rights.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier. You can obtain the identifier using the landing.role.getList method ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier. You can obtain the identifier using the landing.role.getList method ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.isEnabled": { "post": { "summary": "Check if the role model of permissions is enabled: landing.role.isEnabled", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.isEnabled` checks whether the role model of permissions is enabled for the \"Sites and Stores\" section.", "operationId": "landing_role_isEnabled", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/landing-role-is-enabled.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.setAccessCodes": { "post": { "summary": "Set Access Codes for Role landing.role.setAccessCodes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.setAccessCodes` specifies to whom the role is assigned: users, groups, or departments. After invocation, the method reapplies the already saved permissions of this role for the sites.", "operationId": "landing_role_setAccessCodes", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-set-access-codes.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier. You can obtain the identifier using the method landing.role.getList ||" }, "codes": { "type": "string", "description": "| The final list of access codes for the role." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Role identifier. You can obtain the identifier using the method landing.role.getList ||" }, "codes": { "type": "string", "description": "| The final list of access codes for the role." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.role.setRights": { "post": { "summary": "Set Role Permissions for the Site List landing.role.setRights", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.setRights` sets role permissions for sites. You can specify separate permissions for each site, while others will have default permissions. The new set of permissions completely replaces the previous one.", "operationId": "landing_role_setRights", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-set-rights.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the role for which permissions need to be updated." }, "rights": { "type": "object", "description": "\\| `array` | An object in the following format:" }, "additional": { "type": "string", "description": "| Additional capabilities of the role." }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "id", "rights" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the role for which permissions need to be updated." }, "rights": { "type": "object", "description": "\\| `array` | An object in the following format:" }, "additional": { "type": "string", "description": "| Additional capabilities of the role." }, "Code": { "type": "string", "description": "| Description ||" } }, "required": [ "id", "rights" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.add": { "post": { "summary": "Add site landing.site.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.add` creates a new site and returns the identifier of the created site.", "operationId": "landing_site_add", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "fields": { "type": "object", "description": "| Set of fields for the new site (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the site, up to `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the site. If an empty string is passed, the code will be generated from the `TITLE` field. For codes that consist only of digits, a prefix `site` will be automatically added." }, "TYPE": { "type": "string", "description": "| Type of the site. Default is `PAGE`. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Domain of the site. The value depends on the platform." }, "DESCRIPTION": { "type": "string", "description": "| Description of the site, up to `255` characters ||" }, "XML_ID": { "type": "string", "description": "| External identifier, up to `255` characters ||" }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the site, stored separately after creation ||" }, "fields.TYPE": { "type": "string", "description": "| scope in request | When to use ||" } }, "required": [ "fields", "TITLE", "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "fields": { "type": "object", "description": "| Set of fields for the new site (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the site, up to `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the site. If an empty string is passed, the code will be generated from the `TITLE` field. For codes that consist only of digits, a prefix `site` will be automatically added." }, "TYPE": { "type": "string", "description": "| Type of the site. Default is `PAGE`. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Domain of the site. The value depends on the platform." }, "DESCRIPTION": { "type": "string", "description": "| Description of the site, up to `255` characters ||" }, "XML_ID": { "type": "string", "description": "| External identifier, up to `255` characters ||" }, "ADDITIONAL_FIELDS": { "type": "object", "description": "| Additional fields of the site, stored separately after creation ||" }, "fields.TYPE": { "type": "string", "description": "| scope in request | When to use ||" } }, "required": [ "fields", "TITLE", "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.addFolder": { "post": { "summary": "Add Folder to Site landing.site.addFolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.addFolder` creates a folder in the specified site and returns the identifier of the created folder.", "operationId": "landing_site_addFolder", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add-folder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site where the folder needs to be created." }, "fields": { "type": "object", "description": "| Set of fields for the folder being created (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the folder, maximum length `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder for the URL, maximum length `255` characters. If not provided or empty, the code is generated from `TITLE` using transliteration." }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent folder. If the value is `0`, `null`, or empty, the folder is created at the root of the site ||" }, "ACTIVE": { "type": "string", "description": "| Flag indicating the folder's activity `Y/N`, default is `N` ||" } }, "required": [ "siteId", "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site where the folder needs to be created." }, "fields": { "type": "object", "description": "| Set of fields for the folder being created (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the folder, maximum length `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder for the URL, maximum length `255` characters. If not provided or empty, the code is generated from `TITLE` using transliteration." }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent folder. If the value is `0`, `null`, or empty, the folder is created at the root of the site ||" }, "ACTIVE": { "type": "string", "description": "| Flag indicating the folder's activity `Y/N`, default is `N` ||" } }, "required": [ "siteId", "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.bindingToGroup": { "post": { "summary": "Bind to Social Network Group landing.site.bindingToGroup", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.bindingToGroup` binds the Knowledge Base to a Social Network group.", "operationId": "landing_site_bindingToGroup", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.bindingToMenu": { "post": { "summary": "Bind Knowledge Base to Menu landing.site.bindingToMenu", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.bindingToMenu` binds the Knowledge Base to the specified menu.", "operationId": "landing_site_bindingToMenu", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.delete": { "post": { "summary": "Delete Site landing.site.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.delete` only deletes an empty site without pages.", "operationId": "landing_site_delete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope for landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Site identifier" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope for landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Site identifier" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.fullExport": { "post": { "summary": "Exporting the site landing.site.fullExport", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.fullExport` exports the site and its pages into an array for subsequent import, for example, via [landing.demos.register](../demos/landing-demos-register.md).", "operationId": "landing_site_fullExport", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-full-export.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "params": { "type": "object", "description": "| Additional export parameters (detailed description) ||" }, "edit_mode": { "type": "string", "description": "| Hook export mode. When set to `Y`, edit mode is enabled. The default is standard mode ||" }, "scope": { "type": "string", "description": "| Internal scope of the landings. It is not related to the REST scope `landing` or `landing_cloud` in the method name." }, "hooks_disable": { "type": "string", "description": "| Codes of additional fields to be excluded from `ADDITIONAL_FIELDS` at the site and page level." }, "code": { "type": "string", "description": "| Code of the exported site. If not provided, the current site code is used without leading or trailing `/`." }, "name": { "type": "string", "description": "| Name of the site in the export. If not provided, the current site name is used ||" }, "description": { "type": "string", "description": "| Description of the site in the export. If not provided, the current site description is used ||" }, "preview": { "type": "string", "description": "| URL of the main preview image. Defaults to an empty string ||" }, "preview2x": { "type": "string", "description": "| URL of the enlarged preview image. Defaults to an empty string ||" }, "preview3x": { "type": "string", "description": "| URL of the retina preview. Defaults to an empty string ||" }, "preview_url": { "type": "string", "description": "| URL of the template preview. Defaults to an empty string ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "params": { "type": "object", "description": "| Additional export parameters (detailed description) ||" }, "edit_mode": { "type": "string", "description": "| Hook export mode. When set to `Y`, edit mode is enabled. The default is standard mode ||" }, "scope": { "type": "string", "description": "| Internal scope of the landings. It is not related to the REST scope `landing` or `landing_cloud` in the method name." }, "hooks_disable": { "type": "string", "description": "| Codes of additional fields to be excluded from `ADDITIONAL_FIELDS` at the site and page level." }, "code": { "type": "string", "description": "| Code of the exported site. If not provided, the current site code is used without leading or trailing `/`." }, "name": { "type": "string", "description": "| Name of the site in the export. If not provided, the current site name is used ||" }, "description": { "type": "string", "description": "| Description of the site in the export. If not provided, the current site description is used ||" }, "preview": { "type": "string", "description": "| URL of the main preview image. Defaults to an empty string ||" }, "preview2x": { "type": "string", "description": "| URL of the enlarged preview image. Defaults to an empty string ||" }, "preview3x": { "type": "string", "description": "| URL of the retina preview. Defaults to an empty string ||" }, "preview_url": { "type": "string", "description": "| URL of the template preview. Defaults to an empty string ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getFolders": { "post": { "summary": "Get Site Folders landing.site.getFolders", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getFolders` returns a list of site folders.", "operationId": "landing_site_getFolders", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-folders.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site for which folders are requested." }, "filter": { "type": "object", "description": "| Filter by folder fields (detailed description) ||" }, "ID": { "type": "integer", "description": "| Identifier of the folder ||" }, "PARENT_ID": { "type": "integer", "description": "\\| `null` | Identifier of the parent folder. If `0`, `null`, `false`, or an empty string is passed, the value will be converted to `null`, which selects top-level folders ||" }, "INDEX_ID": { "type": "integer", "description": "| Identifier of the folder's index page ||" }, "ACTIVE": { "type": "string", "description": "| Active flag `Y/N` ||" }, "DELETED": { "type": "string", "description": "| Deletion flag `Y/N` ||" }, "TITLE": { "type": "string", "description": "| Title of the folder ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Identifier of the user who created the folder ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Identifier of the user who modified the folder ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Date and time of folder creation ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Date and time of folder modification ||" } }, "required": [ "siteId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site for which folders are requested." }, "filter": { "type": "object", "description": "| Filter by folder fields (detailed description) ||" }, "ID": { "type": "integer", "description": "| Identifier of the folder ||" }, "PARENT_ID": { "type": "integer", "description": "\\| `null` | Identifier of the parent folder. If `0`, `null`, `false`, or an empty string is passed, the value will be converted to `null`, which selects top-level folders ||" }, "INDEX_ID": { "type": "integer", "description": "| Identifier of the folder's index page ||" }, "ACTIVE": { "type": "string", "description": "| Active flag `Y/N` ||" }, "DELETED": { "type": "string", "description": "| Deletion flag `Y/N` ||" }, "TITLE": { "type": "string", "description": "| Title of the folder ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder ||" }, "CREATED_BY_ID": { "type": "integer", "description": "| Identifier of the user who created the folder ||" }, "MODIFIED_BY_ID": { "type": "integer", "description": "| Identifier of the user who modified the folder ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Date and time of folder creation ||" }, "DATE_MODIFY": { "type": "string", "format": "date-time", "description": "| Date and time of folder modification ||" } }, "required": [ "siteId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getGroupBindings": { "post": { "summary": "Get Group Bindings - landing.site.getGroupBindings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getGroupBindings` returns the bindings of Knowledge Bases to groups.", "operationId": "landing_site_getGroupBindings", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "\\| `null` | The identifier of the group for filtering." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "\\| `null` | The identifier of the group for filtering." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getList": { "post": { "summary": "Get the List of Sites landing.site.getList", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getList` retrieves a list of sites based on the selection parameters. By default, only sites with `DELETED = \"N\"` are included in the selection. To retrieve deleted sites, pass `DELETED` or `=DELETED` in the filter.", "operationId": "landing_site_getList", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "params": { "type": "object", "description": "| Parameters for selecting sites (detailed description) ||" }, "select": { "type": "string", "description": "| List of fields to select from basic site fields. If the parameter is not passed or is not an array, `[\"*\"]` is used. The method always adds `ID` and `TYPE` to the selection. ||" }, "filter": { "type": "object", "description": "| Filter by fields from basic site fields. If the parameter is not passed or is not an array, an empty filter `{}` is used." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC DESC\"}`. If the parameter is not passed, no special sorting is applied. ||" }, "group": { "type": "array", "items": {}, "description": "| Grouping in ORM format. If not an array, the parameter is converted to an empty array. When filtering by access rights, `ID` is added to the grouping. ||" }, "limit": { "type": "integer", "description": "| Limit on the number of rows in the selection at the ORM level. By default, it is not set. ||" }, "offset": { "type": "integer", "description": "| Offset for the selection at the ORM level. If the parameter is not passed, the default ORM behavior is applied. ||" }, "params.filter.TYPE": { "type": "string", "description": "| scope in request | When to use ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "params": { "type": "object", "description": "| Parameters for selecting sites (detailed description) ||" }, "select": { "type": "string", "description": "| List of fields to select from basic site fields. If the parameter is not passed or is not an array, `[\"*\"]` is used. The method always adds `ID` and `TYPE` to the selection. ||" }, "filter": { "type": "object", "description": "| Filter by fields from basic site fields. If the parameter is not passed or is not an array, an empty filter `{}` is used." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC DESC\"}`. If the parameter is not passed, no special sorting is applied. ||" }, "group": { "type": "array", "items": {}, "description": "| Grouping in ORM format. If not an array, the parameter is converted to an empty array. When filtering by access rights, `ID` is added to the grouping. ||" }, "limit": { "type": "integer", "description": "| Limit on the number of rows in the selection at the ORM level. By default, it is not set. ||" }, "offset": { "type": "integer", "description": "| Offset for the selection at the ORM level. If the parameter is not passed, the default ORM behavior is applied. ||" }, "params.filter.TYPE": { "type": "string", "description": "| scope in request | When to use ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getMenuBindings": { "post": { "summary": "Get Menu Bindings with landing.site.getMenuBindings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getMenuBindings` returns Knowledge Base bindings to the menu.", "operationId": "landing_site_getMenuBindings", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "menuCode": { "type": "string", "description": "\\| `null` | Menu code for filtering." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "menuCode": { "type": "string", "description": "\\| `null` | Menu code for filtering." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getPreview": { "post": { "summary": "Get URL Preview of the Site landing.site.getPreview", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getPreview` returns the URL preview of the site's index page.", "operationId": "landing_site_getPreview", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-preview.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Site identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Site identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getPublicUrl": { "post": { "summary": "Get Public URL of the Site landing.site.getPublicUrl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getPublicUrl` returns the complete public URL of a site or multiple sites.", "operationId": "landing_site_getPublicUrl", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "\\| `array` | Identifier of the site or an array of site identifiers. If a single identifier is provided, the `result` will return a URL string." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "\\| `array` | Identifier of the site or an array of site identifiers. If a single identifier is provided, the `result` will return a URL string." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getRights": { "post": { "summary": "Get Access Permissions for landing.site.getRights", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getRights` retrieves the list of permissions for the current user for the specified site.", "operationId": "landing_site_getRights", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/extended-model/landing-site-get-rights.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.getadditionalfields": { "post": { "summary": "Get Additional Fields of the Site landing.site.getadditionalfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getadditionalfields` retrieves additional fields of the site.", "operationId": "landing_site_getadditionalfields", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-additional-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markDelete": { "post": { "summary": "Mark the site as deleted landing.site.markDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markDelete` marks the site as deleted and moves it to the trash.", "operationId": "landing_site_markDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markFolderDelete": { "post": { "summary": "Mark a Folder as Deleted landing.site.markFolderDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markFolderDelete` marks a folder as deleted and moves it to the trash. Upon successful execution, the method also marks the pages within this folder and any nested folders as deleted.", "operationId": "landing_site_markFolderDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markFolderUnDelete": { "post": { "summary": "Restore Folder from Recycle Bin landing.site.markFolderUnDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markFolderUnDelete` restores a folder from the recycle bin and removes the deletion mark from this folder and the pages within it.", "operationId": "landing_site_markFolderUnDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-undelete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.markUnDelete": { "post": { "summary": "Restore Site from Recycle Bin landing.site.markUnDelete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markUnDelete` restores a site from the recycle bin and removes the deletion flag. After restoration, the site remains unpublished (`ACTIVE = \"N\"`).", "operationId": "landing_site_markUnDelete", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-undelete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of landings. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.publication": { "post": { "summary": "Publish the site landing.site.publication", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.publication` publishes the site and its pages. If a page is inactive (`ACTIVE = \"N\"`), it remains unpublished (`PUBLIC = \"N\"`). When the method is called, non-deleted site folders (`DELETED = \"N\"`) are also activated. For the Knowledge Base, the method manages the visibility of the site and its pages for users.", "operationId": "landing_site_publication", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.publicationFolder": { "post": { "summary": "Publish the Website Folder landing.site.publicationFolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.publicationFolder` publishes the website folder and its chain of parent folders.", "operationId": "landing_site_publicationFolder", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication-folder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "folderId": { "type": "integer", "description": "| Identifier of the folder." }, "mark": { "type": "boolean", "description": "| Publication flag. `true` (default) publishes the folder, `false` unpublishes the folder." } }, "required": [ "folderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "folderId": { "type": "integer", "description": "| Identifier of the folder." }, "mark": { "type": "boolean", "description": "| Publication flag. `true` (default) publishes the folder, `false` unpublishes the folder." } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.setRights": { "post": { "summary": "Set Access Permissions for landing.site.setRights", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.setRights` sets access permissions in the advanced permission model for the specified site. This method only works in the advanced permission model. If the role model is enabled in the \"Sites and Stores\" section, the call will return `true`, but the saved permissions will not be applied. To enable the advanced permission model, use the method [landing.role.enable](../landing-role-enable.md) with the value `mode: 0`.", "operationId": "landing_site_setRights", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/rights/extended-model/landing-site-set-rights.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Site identifier." }, "rights": { "type": "object", "description": "\\| `array` | Object format:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "\\| `string` | Site identifier." }, "rights": { "type": "object", "description": "\\| `array` | Object format:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unPublicFolder": { "post": { "summary": "Unpublishing a Website Folder landing.site.unPublicFolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unPublicFolder` unpublishes a website folder and its parent folder chain.", "operationId": "landing_site_unPublicFolder", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic-folder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "folderId": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "folderId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name." }, "folderId": { "type": "integer", "description": "| Identifier of the folder." } }, "required": [ "folderId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unbindingFromGroup": { "post": { "summary": "Unbind Knowledge Base from Social Network Group landing.site.unbindingFromGroup", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unbindingFromGroup` removes the binding of the Knowledge Base to a Social Network group.", "operationId": "landing_site_unbindingFromGroup", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unbindingFromMenu": { "post": { "summary": "Unbind Knowledge Base from Menu landing.site.unbindingFromMenu", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unbindingFromMenu` removes the binding of the Knowledge Base from the specified menu.", "operationId": "landing_site_unbindingFromMenu", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.unpublic": { "post": { "summary": "Unpublishing a Site landing.site.unpublic", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unpublic` unpublishes the site and its pages, deactivating the site. For all non-deleted folders of the site, the method also disables activity. For the Knowledge Base, the method hides the site and its pages from users.", "operationId": "landing_site_unpublic", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.update": { "post": { "summary": "Update Site landing.site.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.update` updates the parameters of the site.", "operationId": "landing_site_update", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." }, "fields": { "type": "object", "description": "| Set of fields to update the site (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the site, up to `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the site. If an empty string is passed, the code is generated from `TITLE` or from the string `site`." }, "TYPE": { "type": "string", "description": "| Type of the site. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Domain of the site. Usually, the domain name is passed. For sites of types `PAGE`, `STORE`, `SMN`, if the parameter is not passed or an empty string is provided, the parameter value is ignored. For `GROUP`, `KNOWLEDGE`, and `MAINPAGE`, the parameter is usually not passed." }, "DESCRIPTION": { "type": "string", "description": "| Description of the site, up to `255` characters ||" }, "XML_ID": { "type": "string", "description": "| External identifier of the site ||" }, "LANDING_ID_INDEX": { "type": "integer", "description": "| Identifier of the site page that will be the main one ||" }, "LANDING_ID_404": { "type": "integer", "description": "| Identifier of the 404 error page ||" }, "LANDING_ID_503": { "type": "integer", "description": "| Identifier of the 503 error page ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "id": { "type": "integer", "description": "| Identifier of the site." }, "fields": { "type": "object", "description": "| Set of fields to update the site (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the site, up to `255` characters ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the site. If an empty string is passed, the code is generated from `TITLE` or from the string `site`." }, "TYPE": { "type": "string", "description": "| Type of the site. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`." }, "DOMAIN_ID": { "type": "integer", "description": "\\| `string` | Domain of the site. Usually, the domain name is passed. For sites of types `PAGE`, `STORE`, `SMN`, if the parameter is not passed or an empty string is provided, the parameter value is ignored. For `GROUP`, `KNOWLEDGE`, and `MAINPAGE`, the parameter is usually not passed." }, "DESCRIPTION": { "type": "string", "description": "| Description of the site, up to `255` characters ||" }, "XML_ID": { "type": "string", "description": "| External identifier of the site ||" }, "LANDING_ID_INDEX": { "type": "integer", "description": "| Identifier of the site page that will be the main one ||" }, "LANDING_ID_404": { "type": "integer", "description": "| Identifier of the 404 error page ||" }, "LANDING_ID_503": { "type": "integer", "description": "| Identifier of the 503 error page ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.site.updateFolder": { "post": { "summary": "Change Folder in landing.site.updateFolder", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.updateFolder` updates the parameters of a site folder.", "operationId": "landing_site_updateFolder", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update-folder.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site to which the folder belongs." }, "folderId": { "type": "integer", "description": "| Identifier of the folder to be updated." }, "fields": { "type": "object", "description": "| Set of fields to update the folder (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the folder ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder for the URL. The code cannot contain the character `/`." }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent folder." }, "INDEX_ID": { "type": "integer", "description": "| Identifier of the index page of the folder ||" }, "ACTIVE": { "type": "string", "description": "| Active flag for the folder `Y/N` ||" } }, "required": [ "siteId", "folderId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "description": "| Internal scope of the landing. It is not related to the REST scope `landing` in the method name." }, "siteId": { "type": "integer", "description": "| Identifier of the site to which the folder belongs." }, "folderId": { "type": "integer", "description": "| Identifier of the folder to be updated." }, "fields": { "type": "object", "description": "| Set of fields to update the folder (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Title of the folder ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the folder for the URL. The code cannot contain the character `/`." }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent folder." }, "INDEX_ID": { "type": "integer", "description": "| Identifier of the index page of the folder ||" }, "ACTIVE": { "type": "string", "description": "| Active flag for the folder `Y/N` ||" } }, "required": [ "siteId", "folderId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.deleteForLanding": { "post": { "summary": "Delete All Page Bindings as Special landing.syspage.deleteForLanding", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.deleteForLanding` removes all bindings where the page with the identifier `id` is designated as special for the site. This method does not delete sites or pages. It only removes bindings of special pages. If the same page is designated as special for multiple sites, the method will delete all such bindings at once.", "operationId": "landing_syspage_deleteForLanding", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the page for which all special bindings need to be removed." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the page for which all special bindings need to be removed." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.deleteForSite": { "post": { "summary": "Delete All Bindings of Special Pages for Site landing.syspage.deleteForSite", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.deleteForSite` removes all bindings of special pages for the site. This method does not delete the site or the pages themselves. It only removes the records of the bindings of special pages. All found bindings for the specified site are deleted in a single call.", "operationId": "landing_syspage_deleteForSite", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the site for which all bindings of special pages need to be deleted." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the site for which all bindings of special pages need to be deleted." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.get": { "post": { "summary": "Get a List of Special Pages from landing.syspage.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.get` returns a list of special pages for the site.", "operationId": "landing_syspage_get", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the site." }, "active": { "type": "boolean", "description": "| Return only pages that are not deleted and are active." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the site." }, "active": { "type": "boolean", "description": "| Return only pages that are not deleted and are active." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.getSpecialPage": { "post": { "summary": "Get the URL of the special page using landing.syspage.getSpecialPage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.getSpecialPage` returns the URL of the special page for the site.", "operationId": "landing_syspage_getSpecialPage", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get-special-page.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "siteId": { "type": "integer", "description": "| The site identifier." }, "type": { "type": "string", "description": "| The code of the special page that the method looks for in the site's bindings." }, "additional": { "type": "object", "description": "| Additional URL parameters (detailed description)." } }, "required": [ "siteId", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "siteId": { "type": "integer", "description": "| The site identifier." }, "type": { "type": "string", "description": "| The code of the special page that the method looks for in the site's bindings." }, "additional": { "type": "object", "description": "| Additional URL parameters (detailed description)." } }, "required": [ "siteId", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.syspage.set": { "post": { "summary": "Set a Special Page for the Site landing.syspage.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.set` assigns a special page for the site.", "operationId": "landing_syspage_set", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "type": { "type": "string", "description": "| Code for the special page." }, "lid": { "type": "integer", "description": "| Identifier of the page to be set as special for the site." } }, "required": [ "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "type": { "type": "string", "description": "| Code for the special page." }, "lid": { "type": "integer", "description": "| Identifier of the page to be set as special for the site." } }, "required": [ "id", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getLandingRef": { "post": { "summary": "Get a List of Included Areas for the landing.template.getLandingRef Page", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getLandingRef` retrieves a list of included areas associated with the page. The response includes only the bindings saved for the page. Bindings configured at the site level are not returned by this method. To obtain them, use the method [landing.template.getSiteRef](./landing-template-get-site-ref.md).", "operationId": "landing_template_getLandingRef", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-landing-ref.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the page." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| The identifier of the page." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getSiteRef": { "post": { "summary": "Get a List of Included Areas for the Site landing.template.getSiteRef", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getSiteRef` retrieves a list of included areas associated with the site. The response includes only the bindings saved for the site. Bindings configured for individual pages of this site are not returned by the method. To obtain them, use [landing.template.getLandingRef](./landing-template-get-landing-ref.md).", "operationId": "landing_template_getSiteRef", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-site-ref.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the site." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.getlist": { "post": { "summary": "Get a List of View Templates landing.template.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getlist` retrieves a list of view templates for the current account based on the selection parameters.", "operationId": "landing_template_getlist", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| An object containing the selection parameters for view templates in the following format:" }, "select": { "type": "string", "description": "| A list of fields from the fields of the View Template object." }, "filter": { "type": "object", "description": "| A filter for fields from the fields of the View Template object." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC\"}` or `{\"FIELD\": \"DESC\"}`." }, "group": { "type": "array", "items": {}, "description": "| An array of field names for grouping, such as `[\"ACTIVE\"]` or `[\"ACTIVE\", \"SORT\"]`." }, "limit": { "type": "integer", "description": "| The maximum number of items in the response." }, "offset": { "type": "integer", "description": "| The offset from the start of the selection. Use together with `limit` for pagination ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| An object containing the selection parameters for view templates in the following format:" }, "select": { "type": "string", "description": "| A list of fields from the fields of the View Template object." }, "filter": { "type": "object", "description": "| A filter for fields from the fields of the View Template object." }, "order": { "type": "object", "description": "| Sorting in the format `{\"FIELD\": \"ASC\"}` or `{\"FIELD\": \"DESC\"}`." }, "group": { "type": "array", "items": {}, "description": "| An array of field names for grouping, such as `[\"ACTIVE\"]` or `[\"ACTIVE\", \"SORT\"]`." }, "limit": { "type": "integer", "description": "| The maximum number of items in the response." }, "offset": { "type": "integer", "description": "| The offset from the start of the selection. Use together with `limit` for pagination ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.setLandingRef": { "post": { "summary": "Set Included Areas for landing.template.setLandingRef Page", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.setLandingRef` sets the bindings of included areas for the page. It only works with page bindings and does not alter site bindings. Included areas of the template are separate pages used as parts of the layout, such as the header, footer, or sidebar.", "operationId": "landing_template_setLandingRef", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-landing-ref.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the page." }, "data": { "type": "object", "description": "\\| `array` | Set of bindings for the included areas of the page. (detailed description)" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the page." }, "data": { "type": "object", "description": "\\| `array` | Set of bindings for the included areas of the page. (detailed description)" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/landing.template.setSiteRef": { "post": { "summary": "Set Included Areas for the Site landing.template.setSiteRef", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.setSiteRef` saves the bindings of included areas for the site. It only works with site bindings and does not change the bindings of individual pages.", "operationId": "landing_template_setSiteRef", "tags": [ "Sites" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-site-ref.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "data": { "type": "object", "description": "\\| `array` | A set of bindings for the included areas of the site (detailed description)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Site identifier." }, "data": { "type": "object", "description": "\\| `array` | A set of bindings for the included areas of the site (detailed description)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "landing" ] } ] } }, "/lists.add": { "post": { "summary": "Create a universal list lists.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `lists.add` method creates a universal list.", "operationId": "lists_add", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/lists/lists-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block ||" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. Use this parameter if you want to add the list to a group." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of list fields." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of labels for list items and sections. Supported values:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission." }, "NAME": { "type": "string", "description": "| Name of the list ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the list ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||" }, "BIZPROC": { "type": "string", "description": "| Enabling business process support. Possible values:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block ||" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. Use this parameter if you want to add the list to a group." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of list fields." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of labels for list items and sections. Supported values:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission." }, "NAME": { "type": "string", "description": "| Name of the list ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the list ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||" }, "BIZPROC": { "type": "string", "description": "| Enabling business process support. Possible values:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.delete": { "post": { "summary": "Delete universal list lists.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.delete` removes a universal list.", "operationId": "lists_delete", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/lists/lists-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.add": { "post": { "summary": "Create a list element lists.element.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.add` creates a list element.", "operationId": "lists_element_add", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Identifier of the section to which the element is added." }, "LIST_ELEMENT_URL": { "type": "string", "description": "| Template address to the list elements." }, "NAME": { "type": "string", "description": "| Name of the element ||" }, "PROPERTY_PropertyId": { "type": "string", "description": "| Custom properties." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Identifier of the section to which the element is added." }, "LIST_ELEMENT_URL": { "type": "string", "description": "| Template address to the list elements." }, "NAME": { "type": "string", "description": "| Name of the element ||" }, "PROPERTY_PropertyId": { "type": "string", "description": "| Custom properties." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.delete": { "post": { "summary": "Delete List Element lists.element.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.delete` removes a list element.", "operationId": "lists_element_delete", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." } }, "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": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.get": { "post": { "summary": "Get Element Parameters or List of Elements lists.element.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.get` returns an element or a list of elements.", "operationId": "lists_element_get", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "SELECT": { "type": "array", "items": {}, "description": "| An array containing a list of fields to select. If no fields are specified, all available fields are returned by default." }, "FILTER": { "type": "object", "description": "| An object for filtering element fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "ELEMENT_ORDER": { "type": "object", "description": "| An object for sorting element fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "SELECT": { "type": "array", "items": {}, "description": "| An array containing a list of fields to select. If no fields are specified, all available fields are returned by default." }, "FILTER": { "type": "object", "description": "| An object for filtering element fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "ELEMENT_ORDER": { "type": "object", "description": "| An object for sorting element fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.get.file.url": { "post": { "summary": "Get File Path lists.element.get.file.url", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.get.file.url` returns the file path.", "operationId": "lists_element_get_file_url", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-get-file-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "FIELD_ID": { "type": "integer", "description": "| Identifier of the File or File (Drive) property, without the `PROPERTY_` prefix ||" } }, "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": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "FIELD_ID": { "type": "integer", "description": "| Identifier of the File or File (Drive) property, without the `PROPERTY_` prefix ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELD_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.element.update": { "post": { "summary": "Update List Element lists.element.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.update` updates a list element. The method completely overwrites the element. Fields whose values are not provided will be cleared.", "operationId": "lists_element_update", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the element ||" }, "PROPERTY_PropertyId": { "type": "string", "description": "| Custom properties." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "ELEMENT_ID": { "type": "integer", "description": "| Identifier of the element." }, "ELEMENT_CODE": { "type": "string", "description": "| Symbolic code of the element." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the element ||" }, "PROPERTY_PropertyId": { "type": "string", "description": "| Custom properties." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "ELEMENT_ID", "ELEMENT_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.add": { "post": { "summary": "Create a Field for Universal List lists.field.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.add` creates a list field. You can find the available field types for the universal list using the method [lists.field.type.get](./lists-field-type-get.md)", "operationId": "lists_field_add", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of parameters." }, "NAME": { "type": "string", "description": "| Field name ||" }, "TYPE": { "type": "string", "description": "| Field type. Once created, the field type cannot be changed." }, "IS_REQUIRED": { "type": "string", "description": "| Field required flag. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Field multiplicity flag. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required ||" }, "LIST": { "type": "array", "items": {}, "description": "| Values for the List type field. An array in the format `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, where `'ID'` — temporary identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| An alternative way to specify values for the List type field. A string where values are separated by the newline character `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Default value for the List type field. The array accepts a temporary identifier from `LIST` ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the field. Required for custom fields. Not used for system fields ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Display and behavior settings." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Array of settings for custom fields. The structure depends on the field type:" }, "ROW_COUNT": { "type": "integer", "description": "| Height of the field." }, "COL_COUNT": { "type": "integer", "description": "| Width of the field." }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements as a list ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "NAME", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of parameters." }, "NAME": { "type": "string", "description": "| Field name ||" }, "TYPE": { "type": "string", "description": "| Field type. Once created, the field type cannot be changed." }, "IS_REQUIRED": { "type": "string", "description": "| Field required flag. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Field multiplicity flag. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required ||" }, "LIST": { "type": "array", "items": {}, "description": "| Values for the List type field. An array in the format `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, where `'ID'` — temporary identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| An alternative way to specify values for the List type field. A string where values are separated by the newline character `\\n`" }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Default value for the List type field. The array accepts a temporary identifier from `LIST` ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the field. Required for custom fields. Not used for system fields ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Display and behavior settings." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Array of settings for custom fields. The structure depends on the field type:" }, "ROW_COUNT": { "type": "integer", "description": "| Height of the field." }, "COL_COUNT": { "type": "integer", "description": "| Width of the field." }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements as a list ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "NAME", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.delete": { "post": { "summary": "Delete Field from Universal List lists.field.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.delete` removes a field from the list.", "operationId": "lists_field_delete", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "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": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELD_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.get": { "post": { "summary": "Get Field Parameters or List of Fields lists.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.get` returns data about a field or a list of fields.", "operationId": "lists_field_get", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.type.get": { "post": { "summary": "Get Available Field Types for Universal List lists.field.type.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.type.get` returns a list of available field types for the list.", "operationId": "lists_field_type_get", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-type-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "integer", "description": "| Field identifier. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELD_ID": { "type": "integer", "description": "| Field identifier. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.field.update": { "post": { "summary": "Update the Universal List Field lists.field.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.update` updates a list field. The field type cannot be changed. Please provide the type that was specified when the field was created.", "operationId": "lists_field_update", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of parameters." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." }, "NAME": { "type": "string", "description": "| Field name ||" }, "TYPE": { "type": "string", "description": "| Field type. The type cannot be changed; please provide the one that was specified when the field was created." }, "IS_REQUIRED": { "type": "string", "description": "| Field required flag. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Field multiplicity flag. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required. ||" }, "LIST": { "type": "array", "items": {}, "description": "| Values for the List type field. An array in the format `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, where `'ID'` — identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| An alternative way to specify values for the List type field. A string where values are separated by the newline character `\\n`." }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Default value for the List type field. The array accepts the identifier from `LIST`. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the field. Required for custom fields. Not used for system fields. ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Display and behavior settings." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Array of settings for custom fields. The structure depends on the field type:" }, "ROW_COUNT": { "type": "integer", "description": "| Height of the field. ||" }, "COL_COUNT": { "type": "integer", "description": "| Width of the field. ||" }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements in list form. ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "FIELD_ID", "NAME", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of parameters." }, "FIELD_ID": { "type": "string", "description": "| Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code." }, "NAME": { "type": "string", "description": "| Field name ||" }, "TYPE": { "type": "string", "description": "| Field type. The type cannot be changed; please provide the one that was specified when the field was created." }, "IS_REQUIRED": { "type": "string", "description": "| Field required flag. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Field multiplicity flag. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DEFAULT_VALUE": { "type": "string", "description": "| Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required. ||" }, "LIST": { "type": "array", "items": {}, "description": "| Values for the List type field. An array in the format `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, where `'ID'` — identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator." }, "LIST_TEXT_VALUES": { "type": "string", "description": "| An alternative way to specify values for the List type field. A string where values are separated by the newline character `\\n`." }, "LIST_DEF": { "type": "array", "items": {}, "description": "| Default value for the List type field. The array accepts the identifier from `LIST`. ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the field. Required for custom fields. Not used for system fields. ||" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Display and behavior settings." }, "USER_TYPE_SETTINGS": { "type": "array", "items": {}, "description": "| Array of settings for custom fields. The structure depends on the field type:" }, "ROW_COUNT": { "type": "integer", "description": "| Height of the field. ||" }, "COL_COUNT": { "type": "integer", "description": "| Width of the field. ||" }, "LINK_IBLOCK_ID": { "type": "integer", "description": "| Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements in list form. ||" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "FIELD_ID", "NAME", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.get": { "post": { "summary": "Retrieve Data from Universal List or Array of Lists: lists.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `lists.get` method returns a universal list or an array of lists.", "operationId": "lists_get", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/lists/lists-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block ||" }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. Required for group lists; otherwise, an access error will occur." }, "IBLOCK_ORDER": { "type": "object", "description": "| Object for sorting list fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Parameter used for pagination control." } }, "required": [ "IBLOCK_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block ||" }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block" }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. Required for group lists; otherwise, an access error will occur." }, "IBLOCK_ORDER": { "type": "object", "description": "| Object for sorting list fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "start": { "type": "integer", "description": "| Parameter used for pagination control." } }, "required": [ "IBLOCK_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.get.iblock.type.id": { "post": { "summary": "Get the information block type ID lists.get.iblock.type.id", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.get.iblock.type.id` returns the information block type ID.", "operationId": "lists_get_iblock_type_id", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/lists/lists-get-iblock-type-id.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_ID": { "type": "integer", "description": "| Information block ID." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." } }, "required": [ "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_ID": { "type": "integer", "description": "| Information block ID." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." } }, "required": [ "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.add": { "post": { "summary": "Create a section of the universal list lists.section.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.section.add` creates a list section.", "operationId": "lists_section_add", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/sections/lists-section-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Identifier of the parent section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "EXTERNAL_ID": { "type": "string", "description": "| External identifier of the section ||" }, "XML_ID": { "type": "string", "description": "| External identifier (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Activity status. Possible values:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "DESCRIPTION": { "type": "string", "description": "| Deprecated." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Deprecated." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Deprecated." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "IBLOCK_SECTION_ID": { "type": "integer", "description": "| Identifier of the parent section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section ||" }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "EXTERNAL_ID": { "type": "string", "description": "| External identifier of the section ||" }, "XML_ID": { "type": "string", "description": "| External identifier (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Activity status. Possible values:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "DESCRIPTION": { "type": "string", "description": "| Deprecated." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Deprecated." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Deprecated." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.delete": { "post": { "summary": "Delete the section of the universal list lists.section.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.section.delete` removes a section from the list.", "operationId": "lists_section_delete", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/sections/lists-section-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section." } }, "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": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.get": { "post": { "summary": "Get section parameters or list of sections using lists.section.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.section.get` returns a section or a list of sections.", "operationId": "lists_section_get", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/sections/lists-section-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FILTER": { "type": "object", "description": "| Object for filtering sections `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "SELECT": { "type": "array", "items": {}, "description": "| Array with fields to select. Available fields:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "FILTER": { "type": "object", "description": "| Object for filtering sections `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "SELECT": { "type": "array", "items": {}, "description": "| Array with fields to select. Available fields:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.section.update": { "post": { "summary": "Update the section of the universal list lists.section.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.section.update` updates a list section.", "operationId": "lists_section_update", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/sections/lists-section-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "EXTERNAL_ID": { "type": "string", "description": "| External identifier of the section ||" }, "XML_ID": { "type": "string", "description": "| External identifier (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Activity status. Possible values:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "DESCRIPTION": { "type": "string", "description": "| Deprecated." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Deprecated." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Deprecated." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SECTION_ID": { "type": "integer", "description": "| Identifier of the section." }, "SECTION_CODE": { "type": "string", "description": "| Symbolic code of the section." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of fields." }, "NAME": { "type": "string", "description": "| Name of the section ||" }, "EXTERNAL_ID": { "type": "string", "description": "| External identifier of the section ||" }, "XML_ID": { "type": "string", "description": "| External identifier (XML ID) ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Activity status. Possible values:" }, "PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "DESCRIPTION": { "type": "string", "description": "| Deprecated." }, "DESCRIPTION_TYPE": { "type": "string", "description": "| Deprecated." }, "DETAIL_PICTURE": { "type": "array", "items": {}, "description": "| Deprecated." }, "SECTION_PROPERTY": { "type": "array", "items": {}, "description": "| Deprecated." } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "SECTION_ID", "SECTION_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/lists.update": { "post": { "summary": "Update Universal List lists.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `lists.update` method updates the universal list.", "operationId": "lists_update", "tags": [ "Universal Lists" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/lists/lists/lists-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. It is not necessary to specify this for changing list settings. Use this parameter if you want to move the list to another group." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of list fields." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of labels for list items and sections. Supported values:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission." }, "NAME": { "type": "string", "description": "| Name of the list ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the list ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||" }, "BIZPROC": { "type": "string", "description": "| Enabling business process support. Possible values:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IBLOCK_TYPE_ID": { "type": "string", "description": "| Identifier of the information block type. Possible values:" }, "IBLOCK_ID": { "type": "integer", "description": "| Identifier of the information block." }, "IBLOCK_CODE": { "type": "string", "description": "| Symbolic code of the information block." }, "SOCNET_GROUP_ID": { "type": "integer", "description": "| Group identifier. It is not necessary to specify this for changing list settings. Use this parameter if you want to move the list to another group." }, "FIELDS": { "type": "array", "items": {}, "description": "| Array of list fields." }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of labels for list items and sections. Supported values:" }, "RIGHTS": { "type": "array", "items": {}, "description": "| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission." }, "NAME": { "type": "string", "description": "| Name of the list ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the list ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "PICTURE": { "type": "array", "items": {}, "description": "| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||" }, "BIZPROC": { "type": "string", "description": "| Enabling business process support. Possible values:" } }, "required": [ "IBLOCK_TYPE_ID", "IBLOCK_ID", "IBLOCK_CODE", "FIELDS", "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "lists" ] } ] } }, "/log.blogcomment.add": { "post": { "summary": "Add a comment to the message log.blogcomment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogcomment.add` adds a comment to a News Feed message.", "operationId": "log_blogcomment_add", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/blogcomment/log-blogcomment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the News Feed message." }, "TEXT": { "type": "string", "description": "| The text of the comment. It is considered during duplication checks and is saved in the `POST_TEXT` field ||" }, "FILES": { "type": "array", "items": {}, "description": "| An array of files described according to the file handling rules. Files will be uploaded to the user's Drive and linked to the comment ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the comment is published. Available only to administrators. By default, the current user initiating the method call is used." } }, "required": [ "POST_ID", "TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the News Feed message." }, "TEXT": { "type": "string", "description": "| The text of the comment. It is considered during duplication checks and is saved in the `POST_TEXT` field ||" }, "FILES": { "type": "array", "items": {}, "description": "| An array of files described according to the file handling rules. Files will be uploaded to the user's Drive and linked to the comment ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the comment is published. Available only to administrators. By default, the current user initiating the method call is used." } }, "required": [ "POST_ID", "TEXT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogcomment.delete": { "post": { "summary": "Delete comment from log.blogcomment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogcomment.delete` removes a comment from the News Feed.", "operationId": "log_blogcomment_delete", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/blogcomment/log-blogcomment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "COMMENT_ID": { "type": "integer", "description": "| The identifier of the comment. The value must be greater than `0`." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user performing the deletion. Available only to administrators. By default, the current user who initiated the call is used." } }, "required": [ "COMMENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "COMMENT_ID": { "type": "integer", "description": "| The identifier of the comment. The value must be greater than `0`." }, "USER_ID": { "type": "integer", "description": "| The identifier of the user performing the deletion. Available only to administrators. By default, the current user who initiated the call is used." } }, "required": [ "COMMENT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogcomment.user.get": { "post": { "summary": "Get User Comments log.blogcomment.user.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogcomment.user.get` returns a list of comments on a News Feed post for the specified user and information about attached files.", "operationId": "log_blogcomment_user_get", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/blogcomment/log-blogcomment-user-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user whose comments need to be retrieved. If the identifier is not specified, the method will return comments from the current user." }, "FIRST_ID": { "type": "integer", "description": "| The method will return comments with identifiers greater than the specified value. ||" }, "LAST_ID": { "type": "integer", "description": "| The method will return comments with identifiers less than the specified value. ||" }, "LIMIT": { "type": "integer", "description": "| The number of records in the response. The acceptable value is from `1` to `100`. By default, `100` comments are returned. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user whose comments need to be retrieved. If the identifier is not specified, the method will return comments from the current user." }, "FIRST_ID": { "type": "integer", "description": "| The method will return comments with identifiers greater than the specified value. ||" }, "LAST_ID": { "type": "integer", "description": "| The method will return comments with identifiers less than the specified value. ||" }, "LIMIT": { "type": "integer", "description": "| The number of records in the response. The acceptable value is from `1` to `100`. By default, `100` comments are returned. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.add": { "post": { "summary": "Add a Message to the News Feed log.blogpost.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.add` adds a message to the News Feed.", "operationId": "log_blogpost_add", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "POST_TITLE": { "type": "string", "description": "| Message title ||" }, "DEST": { "type": "array", "items": {}, "description": "| List of recipients who will have permission to view the message." }, "SPERM": { "type": "array", "items": {}, "description": "| Deprecated equivalent of `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Array of files in the format described in working with files." }, "IMPORTANT": { "type": "string", "description": "| Indicator of an important message." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Date and time in ISO 8601 format until which the message will be considered important ||" }, "SITE_ID": { "type": "string", "description": "| Site identifier." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is published. Available only to administrators." }, "TAGS": { "type": "string", "description": "| Message tags ||" }, "BACKGROUND_CODE": { "type": "string", "description": "| Background code of the message ||" }, "PARSE_PREVIEW": { "type": "string", "description": "| Automatic addition of a link preview from the message text." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Alternative to `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Indicator of an important message." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Expiration date of the important message." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Link preview from the message text." }, "UF_GRATITUDE": { "type": "integer", "description": "| Data for the Gratitude functionality in the format:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Survey data in the format:" } }, "required": [ "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "POST_TITLE": { "type": "string", "description": "| Message title ||" }, "DEST": { "type": "array", "items": {}, "description": "| List of recipients who will have permission to view the message." }, "SPERM": { "type": "array", "items": {}, "description": "| Deprecated equivalent of `DEST` ||" }, "FILES": { "type": "array", "items": {}, "description": "| Array of files in the format described in working with files." }, "IMPORTANT": { "type": "string", "description": "| Indicator of an important message." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Date and time in ISO 8601 format until which the message will be considered important ||" }, "SITE_ID": { "type": "string", "description": "| Site identifier." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is published. Available only to administrators." }, "TAGS": { "type": "string", "description": "| Message tags ||" }, "BACKGROUND_CODE": { "type": "string", "description": "| Background code of the message ||" }, "PARSE_PREVIEW": { "type": "string", "description": "| Automatic addition of a link preview from the message text." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Alternative to `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Indicator of an important message." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Expiration date of the important message." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Link preview from the message text." }, "UF_GRATITUDE": { "type": "integer", "description": "| Data for the Gratitude functionality in the format:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Survey data in the format:" } }, "required": [ "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.delete": { "post": { "summary": "Delete News Feed Message log.blogpost.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.delete` removes a message from the News Feed.", "operationId": "log_blogpost_delete", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.get": { "post": { "summary": "Access Available User Messages from the News Feed log.blogpost.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.get` returns messages from the News Feed that are accessible to the current user.", "operationId": "log_blogpost_get", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Filter by message ID." }, "LOG_RIGHTS": { "type": "array", "items": {}, "description": "| Filter by recipients who have the right to view the message." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Filter by message ID." }, "LOG_RIGHTS": { "type": "array", "items": {}, "description": "| Filter by recipients who have the right to view the message." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.getusers.important": { "post": { "summary": "View Users Who Read an Important Message log.blogpost.getusers.important", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.getusers.important` returns an array of user IDs who have read an important message.", "operationId": "log_blogpost_getusers_important", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-getusers-important.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| The identifier of the important message in the News Feed." } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| The identifier of the important message in the News Feed." } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.share": { "post": { "summary": "Add Recipients to News Feed Message log.blogpost.share", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.share` adds new recipients to a news feed message.", "operationId": "log_blogpost_share", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-share.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." }, "DEST": { "type": "array", "items": {}, "description": "| List of new recipients who will be granted access to view the message." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is edited. Available only to administrators." } }, "required": [ "POST_ID", "DEST" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." }, "DEST": { "type": "array", "items": {}, "description": "| List of new recipients who will be granted access to view the message." }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is edited. Available only to administrators." } }, "required": [ "POST_ID", "DEST" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/log.blogpost.update": { "post": { "summary": "Update News Feed Message log.blogpost.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `log.blogpost.update` updates a message in the News Feed.", "operationId": "log_blogpost_update", "tags": [ "News Feed" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/log/log-blogpost-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." }, "POST_MESSAGE": { "type": "string", "description": "| New text of the message. ||" }, "POST_TITLE": { "type": "string", "description": "| New title of the message." }, "DEST": { "type": "array", "items": {}, "description": "| New list of recipients who will have the right to view the message." }, "SPERM": { "type": "array", "items": {}, "description": "| Deprecated equivalent of `DEST`. ||" }, "FILES": { "type": "array", "items": {}, "description": "| Array of files in the format described in working with files." }, "IMPORTANT": { "type": "string", "description": "| Indicator of an important message." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Date and time in ISO 8601 format until which the message will be considered important. ||" }, "SITE_ID": { "type": "string", "description": "| Identifier of the site. ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is edited. Available only to administrators." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Alternative to `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Indicator of an important message." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Expiration date of the important message." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Preview link from the message text." }, "UF_GRATITUDE": { "type": "integer", "description": "| Data for the Gratitude functionality in the format:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Survey data in the format:" } }, "required": [ "POST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "POST_ID": { "type": "integer", "description": "| Identifier of the message." }, "POST_MESSAGE": { "type": "string", "description": "| New text of the message. ||" }, "POST_TITLE": { "type": "string", "description": "| New title of the message." }, "DEST": { "type": "array", "items": {}, "description": "| New list of recipients who will have the right to view the message." }, "SPERM": { "type": "array", "items": {}, "description": "| Deprecated equivalent of `DEST`. ||" }, "FILES": { "type": "array", "items": {}, "description": "| Array of files in the format described in working with files." }, "IMPORTANT": { "type": "string", "description": "| Indicator of an important message." }, "IMPORTANT_DATE_END": { "type": "string", "description": "| Date and time in ISO 8601 format until which the message will be considered important. ||" }, "SITE_ID": { "type": "string", "description": "| Identifier of the site. ||" }, "USER_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the message is edited. Available only to administrators." }, "UF_BLOG_POST_FILE": { "type": "array", "items": {}, "description": "| Alternative to `FILES`." }, "UF_BLOG_POST_IMPRTNT": { "type": "integer", "description": "| Indicator of an important message." }, "UF_IMPRTANT_DATE_END": { "type": "string", "format": "date-time", "description": "| Expiration date of the important message." }, "UF_BLOG_POST_URL_PRV": { "type": "integer", "description": "| Preview link from the message text." }, "UF_GRATITUDE": { "type": "integer", "description": "| Data for the Gratitude functionality in the format:" }, "UF_BLOG_POST_VOTE": { "type": "integer", "description": "| Survey data in the format:" } }, "required": [ "POST_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "log" ] } ] } }, "/mailservice.add": { "post": { "summary": "Create Mail Service mailservice.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `mailservice.add` creates a mail service for the current Bitrix24.", "operationId": "mailservice_add", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the mail service ||" }, "ACTIVE": { "type": "string", "description": "| Service activity status. Allowed values:" }, "SERVER": { "type": "string", "description": "| IMAP server address. Stored in lowercase in the database ||" }, "PORT": { "type": "integer", "description": "| IMAP server port ||" }, "ENCRYPTION": { "type": "string", "description": "| Secure connection status. Allowed values:" }, "LINK": { "type": "string", "description": "| Web interface address of the mail service ||" }, "ICON": { "type": "string", "description": "Bitrix24 type: file" }, "SORT": { "type": "integer", "description": "| Sort index. Default value: `100` ||" } }, "required": [ "NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the mail service ||" }, "ACTIVE": { "type": "string", "description": "| Service activity status. Allowed values:" }, "SERVER": { "type": "string", "description": "| IMAP server address. Stored in lowercase in the database ||" }, "PORT": { "type": "integer", "description": "| IMAP server port ||" }, "ENCRYPTION": { "type": "string", "description": "| Secure connection status. Allowed values:" }, "LINK": { "type": "string", "description": "| Web interface address of the mail service ||" }, "ICON": { "type": "string", "description": "Bitrix24 type: file" }, "SORT": { "type": "integer", "description": "| Sort index. Default value: `100` ||" } }, "required": [ "NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.delete": { "post": { "summary": "Delete Mail Service mailservice.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `mailservice.delete` removes a mail service by its identifier.", "operationId": "mailservice_delete", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.fields": { "post": { "summary": "Get Mail Service Fields mailservice.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `mailservice.fields` returns localized names of the mail service fields.", "operationId": "mailservice_fields", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.get": { "post": { "summary": "Get the mailservice.get method", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `mailservice.get` method returns the parameters of the mail service by its identifier.", "operationId": "mailservice_get", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.list": { "post": { "summary": "Get the list of mail services mailservice.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `mailservice.list` returns a list of active mail services.", "operationId": "mailservice_list", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/mailservice.update": { "post": { "summary": "Update Mail Service mailservice.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `mailservice.update` modifies the parameters of an existing mail service.", "operationId": "mailservice_update", "tags": [ "Mail Services" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/mailservice/mailservice-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." }, "ACTIVE": { "type": "string", "description": "| Service activity status. Acceptable values:" }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "SERVER": { "type": "string", "description": "| IMAP server address. Stored in lowercase in the database. ||" }, "PORT": { "type": "integer", "description": "| IMAP server port ||" }, "ENCRYPTION": { "type": "string", "description": "| Secure connection status. Acceptable values:" }, "LINK": { "type": "string", "description": "| Web interface address of the service ||" }, "ICON": { "type": "string", "description": "Bitrix24 type: file" }, "SORT": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the mail service." }, "ACTIVE": { "type": "string", "description": "| Service activity status. Acceptable values:" }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "SERVER": { "type": "string", "description": "| IMAP server address. Stored in lowercase in the database. ||" }, "PORT": { "type": "integer", "description": "| IMAP server port ||" }, "ENCRYPTION": { "type": "string", "description": "| Secure connection status. Acceptable values:" }, "LINK": { "type": "string", "description": "| Web interface address of the service ||" }, "ICON": { "type": "string", "description": "Bitrix24 type: file" }, "SORT": { "type": "integer", "description": "| Sort index ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "mailservice" ] } ] } }, "/main.eventlog.field.get": { "post": { "summary": "Get Event Log Field main.eventlog.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `main.eventlog.field.get` returns the description of the event log field by name.", "operationId": "main_eventlog_field_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.field.list": { "post": { "summary": "Get the List of Event Log Fields main.eventlog.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `main.eventlog.field.list` returns a list of available fields for event log entries.", "operationId": "main_eventlog_field_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.get": { "post": { "summary": "Get Event Log Entry main.eventlog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `main.eventlog.get` returns an event log entry by its identifier.", "operationId": "main_eventlog_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the log entry ||" }, "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the log entry ||" }, "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.list": { "post": { "summary": "Get the list of event log entries main.eventlog.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `main.eventlog.list` returns a list of event log entries based on specified conditions.", "operationId": "main_eventlog_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." }, "filter": { "type": "array", "items": {}, "description": "| Conditions for filtering entries in the format:" }, "order": { "type": "object", "description": "| Sorting results in the format `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Pagination parameters:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." }, "filter": { "type": "array", "items": {}, "description": "| Conditions for filtering entries in the format:" }, "order": { "type": "object", "description": "| Sorting results in the format `{ \"field\": \"value\" }`." }, "pagination": { "type": "object", "description": "| Pagination parameters:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/main.eventlog.tail": { "post": { "summary": "Get New Log Entries main.eventlog.tail", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `main.eventlog.tail` returns new log entries that appeared after the specified `cursor` reference point, considering the filter.", "operationId": "main_eventlog_tail", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-tail.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." }, "filter": { "type": "array", "items": {}, "description": "| Conditions for filtering records in the format:" }, "cursor": { "type": "object", "description": "| Reference point for retrieving new records:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of fields to return in the response." }, "filter": { "type": "array", "items": {}, "description": "| Conditions for filtering records in the format:" }, "cursor": { "type": "object", "description": "| Reference point for retrieving new records:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "main" ] } ] } }, "/messageservice.message.status.update": { "post": { "summary": "Update Message Delivery Status messageservice.message.status.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `messageservice.message.status.update` updates the delivery status of a message sent through a messaging provider. This method works only within the context of an [application](../../settings/app-installation/index.md).", "operationId": "messageservice_message_status_update", "tags": [ "Message Providers" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/messageservice/messageservice-message-status-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." }, "MESSAGE_ID": { "type": "string", "description": "| External identifier of the message, received by the application handler when the message was sent. ||" }, "STATUS": { "type": "string", "description": "| New status of the message." } }, "required": [ "CODE", "MESSAGE_ID", "STATUS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." }, "MESSAGE_ID": { "type": "string", "description": "| External identifier of the message, received by the application handler when the message was sent. ||" }, "STATUS": { "type": "string", "description": "| New status of the message." } }, "required": [ "CODE", "MESSAGE_ID", "STATUS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.add": { "post": { "summary": "Register an SMS Provider or Message Provider messageservice.sender.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `messageservice.sender.add` registers a new message provider. This method works only in the context of an [application](../../settings/app-installation/index.md).", "operationId": "messageservice_sender_add", "tags": [ "Message Providers" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/messageservice/messageservice-sender-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." }, "TYPE": { "type": "string", "description": "| Provider type." }, "HANDLER": { "type": "string", "description": "| Application handler URL that is called when sending a message." } }, "required": [ "CODE", "TYPE", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." }, "TYPE": { "type": "string", "description": "| Provider type." }, "HANDLER": { "type": "string", "description": "| Application handler URL that is called when sending a message." } }, "required": [ "CODE", "TYPE", "HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.delete": { "post": { "summary": "Delete SMS Provider or Message Provider messageservice.sender.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `messageservice.sender.delete` removes a previously registered message provider for the current application. This method works only within the context of an [application](../../settings/app-installation/index.md).", "operationId": "messageservice_sender_delete", "tags": [ "Message Providers" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/messageservice/messageservice-sender-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Provider code." } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.list": { "post": { "summary": "Get a List of SMS Providers or Message Providers messageservice.sender.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `messageservice.sender.list` returns a list of provider codes registered with the current application. This method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "messageservice_sender_list", "tags": [ "Message Providers" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/messageservice/messageservice-sender-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/messageservice.sender.update": { "post": { "summary": "Update Message Provider messageservice.sender.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `messageservice.sender.update` updates the data of a registered message provider. This method works only in the context of an [application](../../settings/app-installation/index.md).", "operationId": "messageservice_sender_update", "tags": [ "Message Providers" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/messageservice/messageservice-sender-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The code of the provider to be updated." }, "HANDLER": { "type": "string", "description": "| New application handler URL. ||" } }, "required": [ "CODE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| The code of the provider to be updated." }, "HANDLER": { "type": "string", "description": "| New application handler URL. ||" } }, "required": [ "CODE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "messageservice" ] } ] } }, "/method.get": { "post": { "summary": "Get a list of available methods method.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `method.get` method returns two parameters `isExisting` and `isAvailable`, which determine the existence of the method on the account and its availability for invocation.", "operationId": "method_get", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/method-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the method to check in lowercase, for example `user.get` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the method to check in lowercase, for example `user.get` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/methods": { "post": { "summary": "Get a List of Available Methods", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `methods` method retrieves a list of available methods. Development of this method has been halted. Please use [method.get](./method-get.md).", "operationId": "methods", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/methods.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "full": { "type": "boolean", "description": "| If the parameter is set to `true`, the method will return a list of all methods ||" }, "scope": { "type": "string", "description": "| Displays methods included in the specified permission. If the parameter is provided without a value (`methods?scope=&auth=xxxxx`), all common methods will be displayed. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "full": { "type": "boolean", "description": "| If the parameter is set to `true`, the method will return a list of all methods ||" }, "scope": { "type": "string", "description": "| Displays methods included in the specified permission. If the parameter is provided without a value (`methods?scope=&auth=xxxxx`), all common methods will be displayed. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/placement.bind": { "post": { "summary": "Set Up the Widget Handler placement.bind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `placement.bind` adds a handler for the widget placement. It can be called at any time during the application's operation; however, it is often more convenient to register your widgets during the [application installation](../../settings/app-installation/index.md). It is important to note that until the application installation is complete, the widgets you register will not be available to regular users in the Bitrix24 interface—they will only be visible to users with administrative rights.", "operationId": "placement_bind", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/placement-bind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PLACEMENT": { "type": "string", "description": "| Identifier for the required widget placement location ||" }, "HANDLER": { "type": "string", "description": "| URL of the widget placement handler ||" }, "TITLE": { "type": "string", "description": "| Name of the widget in the interface. Depending on the specific placement location, this may be the name of a tab in a form, a menu item, etc. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the widget in the interface. Not used in practice ||" }, "GROUP_NAME": { "type": "string", "description": "| Allows grouping UI elements for multiple handlers of the same widget type. For example, several dropdown items in the top button of the CRM card. Supported only by certain types of widgets ||" }, "LANG_ALL": { "type": "object", "description": "| Array of parameters `TITLE`, `DESCRIPTION`, and `GROUP_NAME` for specified languages. Users who have selected one of these languages in the Bitrix24 interface will see localized versions of `TITLE`, `DESCRIPTION`, and `GROUP_NAME`:" }, "OPTIONS": { "type": "object", "description": "| Additional display parameters for the widget. Specific values depend on the widget placement location. Currently used in widgets for messengers, in the widget `PAGE_BACKGROUND_WORKER`, and in the widget CRM_XXX_DETAIL_ACTIVITY" }, "USER_ID": { "type": "integer", "description": "| Identifier of the Bitrix24 user for whom the registered widget will be available. Possible values can be obtained using the user.get method." } }, "required": [ "PLACEMENT", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PLACEMENT": { "type": "string", "description": "| Identifier for the required widget placement location ||" }, "HANDLER": { "type": "string", "description": "| URL of the widget placement handler ||" }, "TITLE": { "type": "string", "description": "| Name of the widget in the interface. Depending on the specific placement location, this may be the name of a tab in a form, a menu item, etc. ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the widget in the interface. Not used in practice ||" }, "GROUP_NAME": { "type": "string", "description": "| Allows grouping UI elements for multiple handlers of the same widget type. For example, several dropdown items in the top button of the CRM card. Supported only by certain types of widgets ||" }, "LANG_ALL": { "type": "object", "description": "| Array of parameters `TITLE`, `DESCRIPTION`, and `GROUP_NAME` for specified languages. Users who have selected one of these languages in the Bitrix24 interface will see localized versions of `TITLE`, `DESCRIPTION`, and `GROUP_NAME`:" }, "OPTIONS": { "type": "object", "description": "| Additional display parameters for the widget. Specific values depend on the widget placement location. Currently used in widgets for messengers, in the widget `PAGE_BACKGROUND_WORKER`, and in the widget CRM_XXX_DETAIL_ACTIVITY" }, "USER_ID": { "type": "integer", "description": "| Identifier of the Bitrix24 user for whom the registered widget will be available. Possible values can be obtained using the user.get method." } }, "required": [ "PLACEMENT", "HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/placement.get": { "post": { "summary": "Get a List of Registered Placement Handlers placement.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `placement.get` retrieves a list of registered widget placement handlers.", "operationId": "placement_get", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/placement-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/placement.list": { "post": { "summary": "Get a List of Available Application Embed Locations placement.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `placement.list` returns a list of available embed locations for the application. The method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "placement_list", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/placement-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| Limits the list of embed locations to a specific application scope." }, "FULL": { "type": "boolean", "description": "| Flag to retrieve the full list of embed locations." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SCOPE": { "type": "string", "description": "| Limits the list of embed locations to a specific application scope." }, "FULL": { "type": "boolean", "description": "| Flag to retrieve the full list of embed locations." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/placement.unbind": { "post": { "summary": "Remove Registered Automation Rule Handler placement.unbind", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `placement.unbind` removes the registered Automation rule handler. The method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "placement_unbind", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/placement-unbind.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "HANDLER": { "type": "string", "description": "| URL of the Automation rule handler." }, "USER_ID": { "type": "integer", "description": "| Identifier of the Bitrix24 user for whom the handler was registered." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "HANDLER": { "type": "string", "description": "| URL of the Automation rule handler." }, "USER_ID": { "type": "integer", "description": "| Identifier of the Bitrix24 user for whom the handler was registered." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "placement" ] } ] } }, "/profile": { "post": { "summary": "Get Basic Information About the Current User Profile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `profile` method allows you to retrieve basic information about the current user without any scopes, unlike [user.current](../../user/user-current.md). No parameters required.", "operationId": "profile", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/users/profile.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The object contains information about the user ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The object contains information about the user ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/rpa.comment.add": { "post": { "summary": "Create a New Comment in the Timeline rpa.comment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method creates a new comment in the timeline of the item with the identifier `itemId` for the process with the identifier `typeId`.", "operationId": "rpa_comment_add", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the item ||" }, "fields": { "type": "object", "description": "| Object describing the fields of the comment ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML and BB-code formatting can be used ||" }, "files": { "type": "array", "items": {}, "description": "| Array of attached files. Each element is an array containing the name and content encoded in base64 ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the item ||" }, "fields": { "type": "object", "description": "| Object describing the fields of the comment ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML and BB-code formatting can be used ||" }, "files": { "type": "array", "items": {}, "description": "| Array of attached files. Each element is an array containing the name and content encoded in base64 ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.comment.delete": { "post": { "summary": "Delete Comment rpa.comment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes a comment with the identifier `id`. It only allows the deletion of comments that were added by the same user.", "operationId": "rpa_comment_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Record identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Record identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.comment.update": { "post": { "summary": "Update Timeline Entry rpa.comment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the timeline entry with the identifier `id`. It only updates the `title` and `description` fields. The method allows changes only to comments that were added by the same user.", "operationId": "rpa_comment_update", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the comment ||" }, "fields": { "type": "object", "description": "| An object describing the fields of the comment ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the comment ||" }, "fields": { "type": "object", "description": "| An object describing the fields of the comment ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.getSettings": { "post": { "summary": "Get the Complete Set of Field Visibility Settings rpa.fields.getSettings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method retrieves the complete set of field visibility settings for the stage with the identifier `stageId` in the process with the identifier `typeId`.", "operationId": "rpa_fields_getSettings", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-get-settings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage." } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage." } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.setSettings": { "post": { "summary": "Set Full Visibility Settings for rpa.fields.setSettings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method sets the full visibility settings for fields at the stage with the identifier `stageId` of the process with the identifier `typeId`.", "operationId": "rpa_fields_setSettings", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-set-settings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "number", "description": "| Identifier of the process ||" }, "stageId": { "type": "number", "description": "| Identifier of the stage." }, "fields": { "type": "object", "description": "| Array with field visibility settings." } }, "required": [ "typeId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "number", "description": "| Identifier of the process ||" }, "stageId": { "type": "number", "description": "| Identifier of the stage." }, "fields": { "type": "object", "description": "| Array with field visibility settings." } }, "required": [ "typeId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.fields.setVisibilitySettings": { "post": { "summary": "Change Field Visibility Settings rpa.fields.setVisibilitySettings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the `visibility` settings of `fields` for the process with the identifier `typeId` at the stage with the identifier `stageId`. Other settings remain unchanged. The method should be used when you need to change the visibility settings for only one type.", "operationId": "rpa_fields_setVisibilitySettings", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-set-visibility-settings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "visibility": { "type": "string", "description": "| Identifier of the visibility for which the settings are being changed ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage." }, "fields": { "type": "array", "items": {}, "description": "| Array of fields for which the settings need to be changed ||" } }, "required": [ "typeId", "visibility", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "visibility": { "type": "string", "description": "| Identifier of the visibility for which the settings are being changed ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage." }, "fields": { "type": "array", "items": {}, "description": "| Array of fields for which the settings need to be changed ||" } }, "required": [ "typeId", "visibility", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.add": { "post": { "summary": "Add Process Element rpa.item.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method adds a new process element with the identifier `typeId`. To upload a file, you need to pass an array as the value of the custom field, where the first element is the file name and the second is the base64 encoded content of the file.", "operationId": "rpa_item_add", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "fields": { "type": "array", "items": {}, "description": "| Values of the custom fields of the element. All other fields will be ignored ||" } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "fields": { "type": "array", "items": {}, "description": "| Values of the custom fields of the element. All other fields will be ignored ||" } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.delete": { "post": { "summary": "Delete Element rpa.item.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes an element.", "operationId": "rpa_item_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "id": { "type": "integer", "description": "| Element identifier ||" } }, "required": [ "typeId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "id": { "type": "integer", "description": "| Element identifier ||" } }, "required": [ "typeId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.get": { "post": { "summary": "Get Information About the rpa.item.get Element", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves information about the element with the identifier `id` of the process with the identifier `typeId`.", "operationId": "rpa_item_get", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "id": { "type": "integer", "description": "| Identifier of the element ||" }, "Name": { "type": "string", "description": "| Description ||" }, "stageId": { "type": "string", "description": "| Identifier of the stage the element is currently in ||" }, "previousStageId": { "type": "string", "description": "| Identifier of the previous stage of the element ||" }, "name": { "type": "string", "description": "| Name of the element ||" }, "createdBy": { "type": "string", "description": "| Identifier of the user who created the element ||" }, "updatedBy": { "type": "string", "description": "| Identifier of the user who modified the element ||" }, "movedBy": { "type": "string", "description": "| Identifier of the user who changed the stage of the element ||" }, "createdTime": { "type": "string", "description": "| Time the element was created ||" }, "updatedTime": { "type": "string", "description": "| Time the element was modified ||" }, "movedTime": { "type": "string", "description": "| Time the stage of the element was changed ||" }, "detailUrl": { "type": "string", "description": "| Link to the detail form of the element ||" }, "tasksCounter": { "type": "string", "description": "| Number of tasks associated with the element for the user ||" }, "tasksFaces": { "type": "string", "description": "| Information for rendering the sequence of responsible parties during approval:" }, "users": { "type": "string", "description": "| Aggregated information about all users related to the element. A list where the key is the user identifier:" }, "UF_RPA_...": { "type": "string", "description": "| Values of custom fields." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "id": { "type": "integer", "description": "| Identifier of the element ||" }, "Name": { "type": "string", "description": "| Description ||" }, "stageId": { "type": "string", "description": "| Identifier of the stage the element is currently in ||" }, "previousStageId": { "type": "string", "description": "| Identifier of the previous stage of the element ||" }, "name": { "type": "string", "description": "| Name of the element ||" }, "createdBy": { "type": "string", "description": "| Identifier of the user who created the element ||" }, "updatedBy": { "type": "string", "description": "| Identifier of the user who modified the element ||" }, "movedBy": { "type": "string", "description": "| Identifier of the user who changed the stage of the element ||" }, "createdTime": { "type": "string", "description": "| Time the element was created ||" }, "updatedTime": { "type": "string", "description": "| Time the element was modified ||" }, "movedTime": { "type": "string", "description": "| Time the stage of the element was changed ||" }, "detailUrl": { "type": "string", "description": "| Link to the detail form of the element ||" }, "tasksCounter": { "type": "string", "description": "| Number of tasks associated with the element for the user ||" }, "tasksFaces": { "type": "string", "description": "| Information for rendering the sequence of responsible parties during approval:" }, "users": { "type": "string", "description": "| Aggregated information about all users related to the element. A list where the key is the user identifier:" }, "UF_RPA_...": { "type": "string", "description": "| Values of custom fields." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.getTasks": { "post": { "summary": "Get Data on Current Tasks of the Element rpa.item.getTasks", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves data on the current tasks of the element with the identifier `id` for the process with the identifier `typeId`.", "operationId": "rpa_item_getTasks", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-get-tasks.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "id": { "type": "integer", "description": "| Identifier of the element ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "id": { "type": "integer", "description": "| Identifier of the element ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.list": { "post": { "summary": "Retrieve an Array of Process Elements rpa.item.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart Processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves a list of process elements with the identifier `typeId`.", "operationId": "rpa_item_list", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "order": { "type": "number", "description": "| List for sorting, where the key is the field and the value is `ASC` or `DESC` ||" }, "filter": { "type": "number", "description": "| List for filtering." }, "start": { "type": "number", "description": "| Offset for pagination. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "order": { "type": "number", "description": "| List for sorting, where the key is the field and the value is `ASC` or `DESC` ||" }, "filter": { "type": "number", "description": "| List for filtering." }, "start": { "type": "number", "description": "| Offset for pagination. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.item.update": { "post": { "summary": "Update Process Element rpa.item.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method updates the element with the identifier `id` in the process with the identifier `typeId`.", "operationId": "rpa_item_update", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "id": { "type": "integer", "description": "| Element identifier ||" }, "fields": { "type": "object", "description": "| Object containing values for custom fields of the element ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "id": { "type": "integer", "description": "| Element identifier ||" }, "fields": { "type": "object", "description": "| Object containing values for custom fields of the element ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.add": { "post": { "summary": "Create a New Stage rpa.stage.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method adds a new stage.", "operationId": "rpa_stage_add", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/stage/rpa-stage-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with fields of the stage ||" } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with fields of the stage ||" } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.delete": { "post": { "summary": "Delete Stage rpa.stage.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes a stage. A process must always have one successful stage. It is not possible to delete a successful stage.", "operationId": "rpa_stage_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/stage/rpa-stage-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.get": { "post": { "summary": "Get Information About Stage rpa.stage.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves information about a stage by its `id`.", "operationId": "rpa_stage_get", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/stage/rpa-stage-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" }, "Name": { "type": "string", "description": "| Description ||" }, "name": { "type": "string", "description": "| Name of the stage ||" }, "code": { "type": "string", "description": "| Symbolic code. Can be used as an external identifier ||" }, "color": { "type": "string", "description": "| HEX color code of the stage, 6 characters ||" }, "sort": { "type": "string", "description": "| Sorting index ||" }, "semantic": { "type": "string", "description": "| Semantic code of the stage. Can be either `SUCCESS` or `FAIL` ||" }, "typeId": { "type": "string", "description": "| Identifier of the process ||" }, "isFirst": { "type": "string", "description": "| Computed field. Returns `true` if this is the first stage of the process ||" }, "isSuccess": { "type": "string", "description": "| Computed field. Returns `true` if this stage is successful ||" }, "isFail": { "type": "string", "description": "| Computed field. Returns `true` if this stage has failed ||" }, "tasks": { "type": "string", "description": "| Array of tasks for the stage. Each entry has the following structure:" }, "robotsCount": { "type": "string", "description": "| computed field. Number of robots at the stage ||" }, "possibleNextStages": { "type": "string", "description": "| array of identifiers of stages to which the item can be moved. Not used ||" }, "permissions": { "type": "string", "description": "| set of permissions for the kanban:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" }, "Name": { "type": "string", "description": "| Description ||" }, "name": { "type": "string", "description": "| Name of the stage ||" }, "code": { "type": "string", "description": "| Symbolic code. Can be used as an external identifier ||" }, "color": { "type": "string", "description": "| HEX color code of the stage, 6 characters ||" }, "sort": { "type": "string", "description": "| Sorting index ||" }, "semantic": { "type": "string", "description": "| Semantic code of the stage. Can be either `SUCCESS` or `FAIL` ||" }, "typeId": { "type": "string", "description": "| Identifier of the process ||" }, "isFirst": { "type": "string", "description": "| Computed field. Returns `true` if this is the first stage of the process ||" }, "isSuccess": { "type": "string", "description": "| Computed field. Returns `true` if this stage is successful ||" }, "isFail": { "type": "string", "description": "| Computed field. Returns `true` if this stage has failed ||" }, "tasks": { "type": "string", "description": "| Array of tasks for the stage. Each entry has the following structure:" }, "robotsCount": { "type": "string", "description": "| computed field. Number of robots at the stage ||" }, "possibleNextStages": { "type": "string", "description": "| array of identifiers of stages to which the item can be moved. Not used ||" }, "permissions": { "type": "string", "description": "| set of permissions for the kanban:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.listForType": { "post": { "summary": "Get the List of Stages for the rpa.stage.listForType Process", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves a list of process stages, sorted in order with final stages at the end.", "operationId": "rpa_stage_listForType", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/stage/rpa-stage-list-for-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "typeId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } }, "required": [ "typeId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.stage.update": { "post": { "summary": "Update Stage rpa.stage.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method updates the stage by `id`.", "operationId": "rpa_stage_update", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/stage/rpa-stage-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" }, "fields": { "type": "array", "items": {}, "description": "| Object with fields of the stage ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the stage ||" }, "fields": { "type": "array", "items": {}, "description": "| Object with fields of the stage ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.addUser": { "post": { "summary": "Add User to Existing Task rpa.task.addUser", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. The method `rpa.task.addUser` will add a user to an existing task.", "operationId": "rpa_task_addUser", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/task/rpa-task-add-user.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "stageId": { "type": "integer", "description": "| Stage identifier ||" }, "userValue": { "type": "string", "description": "| String with user in the format `First Last [user ID]` ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Process identifier ||" }, "stageId": { "type": "integer", "description": "| Stage identifier ||" }, "userValue": { "type": "string", "description": "| String with user in the format `First Last [user ID]` ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.delete": { "post": { "summary": "Remove Automation Rule from Process rpa.task.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method removes the Automation rule named `robotName` from the process with the identifier `typeId` at the stage with the identifier `stageId`.", "operationId": "rpa_task_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/task/rpa-task-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage ||" }, "robotName": { "type": "string", "description": "| Name of the Automation rule ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage ||" }, "robotName": { "type": "string", "description": "| Name of the Automation rule ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.task.do": { "post": { "summary": "Execute the rpa.task.do Command", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method executes a task. The set of parameters depends on the task.", "operationId": "rpa_task_do", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/task/rpa-task-do.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.add": { "post": { "summary": "Add a New Timeline Entry rpa.timeline.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method creates a new timeline entry for the `itemId` of the `typeId` process. This method allows modification of only the `title` and `description` fields.", "operationId": "rpa_timeline_add", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/timeline/rpa-timeline-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the item ||" }, "fields": { "type": "object", "description": "| Object containing the fields of the entry ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML tags can be used ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the item ||" }, "fields": { "type": "object", "description": "| Object containing the fields of the entry ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML tags can be used ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.delete": { "post": { "summary": "Delete Timeline Record rpa.timeline.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method deletes a timeline record with the identifier `id`. The method only deletes records that were created by the same user and through the application.", "operationId": "rpa_timeline_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/timeline/rpa-timeline-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the record ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the record ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.listForItem": { "post": { "summary": "Get the Timeline Records List for the rpa.timeline.listForItem Element", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves a list of timeline records for the `itemId` of the `typeId` process. The records are sorted in descending order by creation date, meaning the newest entries appear at the top of the list.", "operationId": "rpa_timeline_listForItem", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/timeline/rpa-timeline-list-for-item.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the element ||" }, "start": { "type": "integer", "description": "| This parameter is used for pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "typeId": { "type": "integer", "description": "| Identifier of the process ||" }, "itemId": { "type": "integer", "description": "| Identifier of the element ||" }, "start": { "type": "integer", "description": "| This parameter is used for pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.update": { "post": { "summary": "Update Timeline Entry rpa.timeline.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the timeline entry with the identifier `id`. The method only updates the `title` and `description` fields, and only for entries created by the same user and through the application.", "operationId": "rpa_timeline_update", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/timeline/rpa-timeline-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the entry ||" }, "fields": { "type": "object", "description": "| Object containing the fields of the entry ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML tags can be used ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the entry ||" }, "fields": { "type": "object", "description": "| Object containing the fields of the entry ||" }, "title": { "type": "string", "description": "| Title of the entry ||" }, "description": { "type": "string", "description": "| Description of the entry. HTML tags can be used ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.timeline.updateIsFixed": { "post": { "summary": "Update the Attachment Flag of rpa.timeline.updateIsFixed", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the attachment flag of a record.", "operationId": "rpa_timeline_updateIsFixed", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/timeline/rpa-timeline-update-is-fixed.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the record ||" }, "isFixed": { "type": "string", "description": "| Attachment flag of the record. Possible values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the record ||" }, "isFixed": { "type": "string", "description": "| Attachment flag of the record. Possible values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.add": { "post": { "summary": "Create Process rpa.type.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method creates a new process.", "operationId": "rpa_type_add", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/type/rpa-type-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A list of process fields. The list of possible fields is described below ||" }, "title": { "type": "string", "description": "| The name of the process ||" }, "image": { "type": "string", "description": "| The image of the process from the list ||" }, "settings": { "type": "array", "items": {}, "description": "| A list of arbitrary settings for the process ||" }, "permissions": { "type": "array", "items": {}, "description": "| A list of objects. Each object describes access permissions for this process ||" } }, "required": [ "fields", "title" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": {}, "description": "| A list of process fields. The list of possible fields is described below ||" }, "title": { "type": "string", "description": "| The name of the process ||" }, "image": { "type": "string", "description": "| The image of the process from the list ||" }, "settings": { "type": "array", "items": {}, "description": "| A list of arbitrary settings for the process ||" }, "permissions": { "type": "array", "items": {}, "description": "| A list of objects. Each object describes access permissions for this process ||" } }, "required": [ "fields", "title" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.delete": { "post": { "summary": "Delete Process rpa.type.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes a process.", "operationId": "rpa_type_delete", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/type/rpa-type-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Process identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Process identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.get": { "post": { "summary": "Get Process Information by ID rpa.type.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves information about a process by its `id`.", "operationId": "rpa_type_get", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/type/rpa-type-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Process identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Process identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.list": { "post": { "summary": "Retrieve a List of Processes with Their Fields rpa.type.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. The method will return an array of processes with their fields.", "operationId": "rpa_type_list", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/type/rpa-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Array of fields to output. By default, all fields are returned. ||" }, "order": { "type": "object", "description": "| List for sorting, where the key is the field and the value is `ASC` or `DESC`. ||" }, "filter": { "type": "object", "description": "| List for filtering. ||" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| Array of fields to output. By default, all fields are returned. ||" }, "order": { "type": "object", "description": "| List for sorting, where the key is the field and the value is `ASC` or `DESC`. ||" }, "filter": { "type": "object", "description": "| List for filtering. ||" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/rpa.type.update": { "post": { "summary": "Update the process rpa.type.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the process by its `id`.", "operationId": "rpa_type_update", "tags": [ "Deprecated Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/outdated/rpa/type/rpa-type-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the process ||" }, "fields": { "type": "array", "items": {}, "description": "| List of process fields. Fully analogous to the set from the rpa.type.add method ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "number", "description": "| Identifier of the process ||" }, "fields": { "type": "array", "items": {}, "description": "| List of process fields. Fully analogous to the set from the rpa.type.add method ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "rpa" ] } ] } }, "/sale.basketitem.add": { "post": { "summary": "Add Item (Position) to the Cart of an Existing Order sale.basketitem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds an item to the cart of an existing order.", "operationId": "sale_basketitem_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item (position) in the cart of the order ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "sort": { "type": "integer", "description": "| Position in the list of order items ||" }, "productid": { "type": "string", "description": "| Product/variation identifier." }, "price": { "type": "number", "format": "double", "description": "| Price including markups and discounts (see the `customPrice` field below)." }, "basePrice": { "type": "number", "format": "double", "description": "| Original price excluding markups and discounts (see the `customPrice` field below)." }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup (see the `customPrice` field below)." }, "currency": { "type": "string", "description": "| Currency of the price. Must match the currency of the order ||" }, "customPrice": { "type": "string", "description": "| Is the price specified manually. Possible values:" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the cart item ||" } }, "required": [ "fields", "orderId", "productid", "currency", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item (position) in the cart of the order ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "sort": { "type": "integer", "description": "| Position in the list of order items ||" }, "productid": { "type": "string", "description": "| Product/variation identifier." }, "price": { "type": "number", "format": "double", "description": "| Price including markups and discounts (see the `customPrice` field below)." }, "basePrice": { "type": "number", "format": "double", "description": "| Original price excluding markups and discounts (see the `customPrice` field below)." }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup (see the `customPrice` field below)." }, "currency": { "type": "string", "description": "| Currency of the price. Must match the currency of the order ||" }, "customPrice": { "type": "string", "description": "| Is the price specified manually. Possible values:" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the cart item ||" } }, "required": [ "fields", "orderId", "productid", "currency", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.addCatalogProduct": { "post": { "summary": "Add a position with a product or service from the catalog module to the cart of an existing order sale.basketitem.addCatalogProduct", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a position (item) with a product or service from the catalog module to the cart of an existing order.", "operationId": "sale_basketitem_addCatalogProduct", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-add-catalog-product.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item (position) in the order cart ||" }, "orderId": { "type": "string", "description": "| Order identifier. Can only be specified when creating a cart position." }, "sort": { "type": "integer", "description": "| Position in the order item list ||" }, "productid": { "type": "string", "description": "| Identifier of the product/variation" }, "price": { "type": "number", "format": "double", "description": "| Price considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "basePrice": { "type": "number", "format": "double", "description": "| Original price without considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "currency": { "type": "string", "description": "| Currency of the price. Must match the currency of the order ||" }, "customPrice": { "type": "string", "description": "| Is the price specified manually:" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the cart position ||" }, "name": { "type": "string", "description": "| Name of the product ||" } }, "required": [ "fields", "orderId", "productid", "currency", "quantity", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item (position) in the order cart ||" }, "orderId": { "type": "string", "description": "| Order identifier. Can only be specified when creating a cart position." }, "sort": { "type": "integer", "description": "| Position in the order item list ||" }, "productid": { "type": "string", "description": "| Identifier of the product/variation" }, "price": { "type": "number", "format": "double", "description": "| Price considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "basePrice": { "type": "number", "format": "double", "description": "| Original price without considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup (see the `customPrice` field below). If not specified, it will be calculated based on catalog data." }, "currency": { "type": "string", "description": "| Currency of the price. Must match the currency of the order ||" }, "customPrice": { "type": "string", "description": "| Is the price specified manually:" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the cart position ||" }, "name": { "type": "string", "description": "| Name of the product ||" } }, "required": [ "fields", "orderId", "productid", "currency", "quantity", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.delete": { "post": { "summary": "Remove item (position) from the cart using sale.basketitem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes an item (position) from the cart in the order.", "operationId": "sale_basketitem_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the cart item (position)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the cart item (position)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.get": { "post": { "summary": "Get Information About a Basket Item (Position) sale.basketitem.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about a basket item (position).", "operationId": "sale_basketitem_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item (position)." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item (position)." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.getFields": { "post": { "summary": "Get Available Fields of the Basket Item (sale.basketitem.getFields)", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of available fields of the basket item. Each field is described as a field settings structure [rest_field_description](../data-types.md). No parameters.", "operationId": "sale_basketitem_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_basket_item, and `value` is an object of type rest_field_description" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_basket_item, and `value` is an object of type rest_field_description" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.getFieldsCatalogProduct": { "post": { "summary": "Get Available Fields of a Basket Item (Product from Catalog) sale.basketitem.getFieldsCatalogProduct", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of available fields for a basket item (position) for the methods [sale.basketitem.addCatalogProduct](./sale-basket-item-add-catalog-product.md) and [sale.basketitem.updateCatalogProduct](./sale-basket-item-update-catalog-product.md) — these methods only work with products from the catalog module in basket items (positions). Unlike [sale.basketitem.getFields](./sale-basket-item-get-fields.md), the method `sale.basketitem.getFieldsCatalogProduct` returns the minimum necessary list of fields for operation. No parameters required.", "operationId": "sale_basketitem_getFieldsCatalogProduct", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the field of the sale_basket_item, and `value` is an object of type rest_field_description" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the field of the sale_basket_item, and `value` is an object of type rest_field_description" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.list": { "post": { "summary": "Get a List of Items (Positions) in the Cart sale.basketitem.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a set of items (positions) in the cart filtered by the specified criteria.", "operationId": "sale_basketitem_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "|" }, "filter": { "type": "object", "description": "| An object for filtering the selected records in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "|" }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.update": { "post": { "summary": "Change the position of the basket in an existing order sale.basketitem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method modifies the position of the basket in an existing order.", "operationId": "sale_basketitem_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order item ||" }, "fields": { "type": "object", "description": "| Values of the fields to be modified ||" }, "sort": { "type": "integer", "description": "| Position in the list of order items ||" }, "price": { "type": "number", "format": "double", "description": "| Price including markups and discounts ||" }, "basePrice": { "type": "number", "format": "double", "description": "| Original price excluding markups and discounts ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the basket item ||" }, "name": { "type": "string", "description": "| Name of the product ||" }, "weight": { "type": "integer", "description": "| Weight of the product ||" }, "dimensions": { "type": "string", "description": "| Dimensions of the product (serialized array) ||" }, "measureCode": { "type": "string", "description": "| Code of the product's unit of measure ||" }, "measureName": { "type": "string", "description": "| Name of the unit of measure ||" }, "canBuy": { "type": "string", "description": "| Availability flag of the product. Possible values:" }, "vatRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage. To specify the \"No VAT\" rate, an empty string should be passed ||" }, "vatIncluded": { "type": "string", "description": "| Flag indicating whether VAT or tax is included in the product price. Possible values:" }, "catalogXmlId": { "type": "string", "description": "| External code of the product catalog ||" }, "productXmlId": { "type": "string", "description": "| External code of the product ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order item ||" }, "fields": { "type": "object", "description": "| Values of the fields to be modified ||" }, "sort": { "type": "integer", "description": "| Position in the list of order items ||" }, "price": { "type": "number", "format": "double", "description": "| Price including markups and discounts ||" }, "basePrice": { "type": "number", "format": "double", "description": "| Original price excluding markups and discounts ||" }, "discountPrice": { "type": "number", "format": "double", "description": "| Amount of the final discount or markup ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the basket item ||" }, "name": { "type": "string", "description": "| Name of the product ||" }, "weight": { "type": "integer", "description": "| Weight of the product ||" }, "dimensions": { "type": "string", "description": "| Dimensions of the product (serialized array) ||" }, "measureCode": { "type": "string", "description": "| Code of the product's unit of measure ||" }, "measureName": { "type": "string", "description": "| Name of the unit of measure ||" }, "canBuy": { "type": "string", "description": "| Availability flag of the product. Possible values:" }, "vatRate": { "type": "number", "format": "double", "description": "| Tax rate in percentage. To specify the \"No VAT\" rate, an empty string should be passed ||" }, "vatIncluded": { "type": "string", "description": "| Flag indicating whether VAT or tax is included in the product price. Possible values:" }, "catalogXmlId": { "type": "string", "description": "| External code of the product catalog ||" }, "productXmlId": { "type": "string", "description": "| External code of the product ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketitem.updateCatalogProduct": { "post": { "summary": "Change the basket item position (catalog product) of an existing order sale.basketitem.updateCatalogProduct", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the basket item position (catalog product) of an existing order.", "operationId": "sale_basketitem_updateCatalogProduct", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-update-catalog-product.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item. Can be obtained using the methods sale.basketitem.addCatalogProduct and sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Object with modifiable fields ||" }, "sort": { "type": "integer", "description": "| Position in the order item list ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the basket item ||" } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item. Can be obtained using the methods sale.basketitem.addCatalogProduct and sale.basketitem.list ||" }, "fields": { "type": "object", "description": "| Object with modifiable fields ||" }, "sort": { "type": "integer", "description": "| Position in the order item list ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External code of the basket item ||" } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.add": { "post": { "summary": "Create a property for a basket item sale.basketproperties.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a property for an item (position) in the basket of an order.", "operationId": "sale_basketproperties_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a property of a basket item (position):" }, "basketId": { "type": "string", "description": "| Identifier of the basket item (position) in the order." }, "name": { "type": "string", "description": "| Property name ||" }, "value": { "type": "string", "description": "| Property value ||" }, "code": { "type": "string", "description": "| Symbolic code of the property ||" }, "sort": { "type": "integer", "description": "| Position in the list of properties." }, "xmlId": { "type": "string", "description": "| External code of the property." } }, "required": [ "fields", "basketId", "name", "value", "code" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a property of a basket item (position):" }, "basketId": { "type": "string", "description": "| Identifier of the basket item (position) in the order." }, "name": { "type": "string", "description": "| Property name ||" }, "value": { "type": "string", "description": "| Property value ||" }, "code": { "type": "string", "description": "| Symbolic code of the property ||" }, "sort": { "type": "integer", "description": "| Position in the list of properties." }, "xmlId": { "type": "string", "description": "| External code of the property." } }, "required": [ "fields", "basketId", "name", "value", "code" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.delete": { "post": { "summary": "Delete Basket Property sale.basketproperties.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a property for an item (position) in the basket of an order.", "operationId": "sale_basketproperties_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item (position) property." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item (position) property." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.get": { "post": { "summary": "Get the value of the basket property sale.basketproperties.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the property for an item (position) in the basket of an order by its identifier.", "operationId": "sale_basketproperties_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item property ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item property ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.getFields": { "post": { "summary": "Get Fields of Basket Properties sale.basketproperties.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of property fields. Each field is described as a settings structure (`rest_field_description`). No parameters.", "operationId": "sale_basketproperties_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketProperties": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object `sale_basket_item_property`, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "basketProperties": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object `sale_basket_item_property`, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.list": { "post": { "summary": "Get a List of Basket Properties sale.basketproperties.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a set of properties for the items (positions) in the basket, selected based on a filter.", "operationId": "sale_basketproperties_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the object `sale_basket_item_property`)." }, "filter": { "type": "object", "description": "| An object for filtering the selected catalog sections in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected groups of properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the object `sale_basket_item_property`)." }, "filter": { "type": "object", "description": "| An object for filtering the selected catalog sections in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected groups of properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.basketproperties.update": { "post": { "summary": "Change the property of the basket item sale.basketproperties.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method modifies the property for an item (position) in the basket of an order.", "operationId": "sale_basketproperties_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order item ||" }, "fields": { "type": "object", "description": "| Values of the fields to be modified (detailed description is provided below) for the basket item (position) property:" }, "name": { "type": "string", "description": "| Name of the property ||" }, "value": { "type": "string", "description": "| Value of the property ||" }, "code": { "type": "string", "description": "| Symbolic code of the property ||" }, "sort": { "type": "integer", "description": "| Position in the list of properties ||" }, "xmlId": { "type": "string", "description": "| External code of the property ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order item ||" }, "fields": { "type": "object", "description": "| Values of the fields to be modified (detailed description is provided below) for the basket item (position) property:" }, "name": { "type": "string", "description": "| Name of the property ||" }, "value": { "type": "string", "description": "| Value of the property ||" }, "code": { "type": "string", "description": "| Symbolic code of the property ||" }, "sort": { "type": "integer", "description": "| Position in the list of properties ||" }, "xmlId": { "type": "string", "description": "| External code of the property ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.add": { "post": { "summary": "Add Correspondence to a Natural or Legal Person sale.businessValuePersonDomain.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.businessValuePersonDomain.add` adds correspondence for the selected payer type to a natural or legal person. This is necessary for the operation of the business meanings mechanism.", "operationId": "sale_businessValuePersonDomain_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating correspondence to a natural or legal person ||" }, "personTypeId": { "type": "string", "description": "| Identifier for the payer type." }, "domain": { "type": "string", "description": "| Value corresponding to the payer type: natural or legal person." } }, "required": [ "fields", "personTypeId", "domain" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating correspondence to a natural or legal person ||" }, "personTypeId": { "type": "string", "description": "| Identifier for the payer type." }, "domain": { "type": "string", "description": "| Value corresponding to the payer type: natural or legal person." } }, "required": [ "fields", "personTypeId", "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.deleteByFilter": { "post": { "summary": "Delete the correspondence with a natural or legal person sale.businessValuePersonDomain.deleteByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.businessValuePersonDomain.deleteByFilter` removes the correspondence with a natural or legal person.", "operationId": "sale_businessValuePersonDomain_deleteByFilter", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for deleting the correspondence with a natural or legal person ||" }, "personTypeId": { "type": "string", "description": "| ID of the payer type. Unique parameter." }, "domain": { "type": "string", "description": "| Value corresponding to the payer type: natural person or legal entity." } }, "required": [ "fields", "personTypeId", "domain" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for deleting the correspondence with a natural or legal person ||" }, "personTypeId": { "type": "string", "description": "| ID of the payer type. Unique parameter." }, "domain": { "type": "string", "description": "| Value corresponding to the payer type: natural person or legal entity." } }, "required": [ "fields", "personTypeId", "domain" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.getFields": { "post": { "summary": "Get Fields Corresponding to a Natural or Legal Person sale.businessValuePersonDomain.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.businessValuePersonDomain.getFields` returns fields corresponding to a natural or legal person. No parameters.", "operationId": "sale_businessValuePersonDomain_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "businessValuePersonDomain": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_business_value_person_domain`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "businessValuePersonDomain": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_business_value_person_domain`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.businessValuePersonDomain.list": { "post": { "summary": "Get a list of matches for a natural or legal person sale.businessValuePersonDomain.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.businessValuePersonDomain.list` retrieves a list of matches for a natural or legal person.", "operationId": "sale_businessValuePersonDomain_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select." }, "filter": { "type": "object", "description": "| An object for filtering the selected matches for a natural or legal person in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected matches for a natural or legal person in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select." }, "filter": { "type": "object", "description": "| An object for filtering the selected matches for a natural or legal person in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected matches for a natural or legal person in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.cashbox.add": { "post": { "summary": "Add Cash Register sale.cashbox.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a cash register.", "operationId": "sale_cashbox_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the cash register ||" }, "REST_CODE": { "type": "string", "description": "| REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the `CODE` parameter ||" }, "EMAIL": { "type": "string", "description": "| Email address to which notifications will be sent in case of errors during receipt printing ||" }, "OFD": { "type": "string", "description": "| OFD handler code. Available OFD handlers:" }, "OFD_SETTINGS": { "type": "object", "description": "| OFD settings (detailed description provided below)." }, "NUMBER_KKM": { "type": "string", "description": "| External identifier of the cash register." }, "ACTIVE": { "type": "string", "description": "| Activity status of the cash register. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting. Default `100` ||" }, "USE_OFFLINE": { "type": "string", "description": "| Whether the cash register is used offline. Possible values:" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Cash register settings according to the settings structure passed in the `CONFIG` key of the `SETTINGS` field of the method sale.cashbox.handler.add." }, "OFD_MODE": { "type": "object", "description": "| Settings related to the OFD operation mode. The `IS_TEST` parameter is passed (`string` with values `Y/N`) — OFD operation mode:" }, "SELLER_INFO": { "type": "object", "description": "| Settings for the \"Seller Information\" section. The required parameter `INN` (`string`) — seller's INN is passed" }, "AUTH": { "type": "object", "description": "| Authorization settings. The `INN` parameter is passed (`string`) — security key" } }, "required": [ "NAME", "REST_CODE", "EMAIL" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the cash register ||" }, "REST_CODE": { "type": "string", "description": "| REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the `CODE` parameter ||" }, "EMAIL": { "type": "string", "description": "| Email address to which notifications will be sent in case of errors during receipt printing ||" }, "OFD": { "type": "string", "description": "| OFD handler code. Available OFD handlers:" }, "OFD_SETTINGS": { "type": "object", "description": "| OFD settings (detailed description provided below)." }, "NUMBER_KKM": { "type": "string", "description": "| External identifier of the cash register." }, "ACTIVE": { "type": "string", "description": "| Activity status of the cash register. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting. Default `100` ||" }, "USE_OFFLINE": { "type": "string", "description": "| Whether the cash register is used offline. Possible values:" }, "SETTINGS": { "type": "array", "items": {}, "description": "| Cash register settings according to the settings structure passed in the `CONFIG` key of the `SETTINGS` field of the method sale.cashbox.handler.add." }, "OFD_MODE": { "type": "object", "description": "| Settings related to the OFD operation mode. The `IS_TEST` parameter is passed (`string` with values `Y/N`) — OFD operation mode:" }, "SELLER_INFO": { "type": "object", "description": "| Settings for the \"Seller Information\" section. The required parameter `INN` (`string`) — seller's INN is passed" }, "AUTH": { "type": "object", "description": "| Authorization settings. The `INN` parameter is passed (`string`) — security key" } }, "required": [ "NAME", "REST_CODE", "EMAIL" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.check.apply": { "post": { "summary": "Save the result of printing the receipt sale.cashbox.check.apply", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method saves the result of printing a receipt that was printed on a REST cash register. The UUID of the receipt is saved when it is printed from the `PRINT_URL` response specified when adding the handler (see [example of implementing a simple cash register on REST API](../../../tutorials/sale/cashbox-add-example.md)).", "operationId": "sale_cashbox_check_apply", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-check-apply.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "UUID": { "type": "string", "description": "| UUID of the receipt ||" }, "PRINT_END_TIME": { "type": "string", "description": "| Time when the receipt printing ended ||" }, "REG_NUMBER_KKT": { "type": "string", "description": "| Registration number of the cash register ||" }, "FISCAL_DOC_ATTR": { "type": "string", "description": "| Fiscal attribute of the document ||" }, "FISCAL_DOC_NUMBER": { "type": "string", "description": "| Fiscal document number ||" }, "FISCAL_RECEIPT_NUMBER": { "type": "string", "description": "| Fiscal receipt number ||" }, "FN_NUMBER": { "type": "string", "description": "| Fiscal storage number ||" }, "SHIFT_NUMBER": { "type": "string", "description": "| Shift number ||" } }, "required": [ "UUID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "UUID": { "type": "string", "description": "| UUID of the receipt ||" }, "PRINT_END_TIME": { "type": "string", "description": "| Time when the receipt printing ended ||" }, "REG_NUMBER_KKT": { "type": "string", "description": "| Registration number of the cash register ||" }, "FISCAL_DOC_ATTR": { "type": "string", "description": "| Fiscal attribute of the document ||" }, "FISCAL_DOC_NUMBER": { "type": "string", "description": "| Fiscal document number ||" }, "FISCAL_RECEIPT_NUMBER": { "type": "string", "description": "| Fiscal receipt number ||" }, "FN_NUMBER": { "type": "string", "description": "| Fiscal storage number ||" }, "SHIFT_NUMBER": { "type": "string", "description": "| Shift number ||" } }, "required": [ "UUID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.delete": { "post": { "summary": "Delete cash register sale.cashbox.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a cash register.", "operationId": "sale_cashbox_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cash register to be deleted ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cash register to be deleted ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.handler.add": { "post": { "summary": "Add Cashbox Handler sale.cashbox.handler.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a REST cashbox handler.", "operationId": "sale_cashbox_handler_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Code of the REST handler. Must be unique among all handlers ||" }, "NAME": { "type": "string", "description": "| Name of the REST handler ||" }, "SORT": { "type": "integer", "description": "| Sorting. Default value: `100` ||" }, "SUPPORTS_FFD105": { "type": "string", "description": "| Indicates whether the cashbox supports fiscal data format version 1.05. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Handler settings (detailed description provided below) ||" }, "PRINT_URL": { "type": "string", "description": "| Address to which data for printing the receipt is sent ||" }, "CHECK_URL": { "type": "string", "description": "| Address for checking the status of the receipt ||" }, "HTTP_VERSION": { "type": "string", "description": "| Version of the HTTP protocol used for requests. Possible values: `1.0`, `1.1`." }, "CONFIG": { "type": "object", "description": "| Structure of settings (detailed description provided below), which the user can set and modify on the cashbox editing page, as well as when adding or updating the cashbox via REST." }, "LABEL": { "type": "string", "description": "| Section header ||" }, "ITEMS": { "type": "object", "description": "| List of settings in the section (detailed description provided below)." }, "TYPE": { "type": "string", "description": "| Type of setting. Possible values:" }, "REQUIRED": { "type": "string", "description": "| Indicates whether the setting is required. Possible values:" }, "DISABLED": { "type": "string", "description": "| Indicates whether editing of the setting is disabled. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Indicates whether the setting is multiple. Possible values:" }, "MULTILINE": { "type": "string", "description": "| Indicates whether the field is multiline. Used for `STRING` type. Possible values:" }, "OPTIONS": { "type": "object", "description": "| List of possible values for the property. Used for `ENUM` type." }, "TIME": { "type": "string", "description": "| Indicates whether time selection is possible. Used for `DATE` type. Possible values:" } }, "required": [ "CODE", "NAME", "SETTINGS", "PRINT_URL", "CHECK_URL", "CONFIG", "LABEL", "ITEMS", "TYPE", "REQUIRED", "OPTIONS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CODE": { "type": "string", "description": "| Code of the REST handler. Must be unique among all handlers ||" }, "NAME": { "type": "string", "description": "| Name of the REST handler ||" }, "SORT": { "type": "integer", "description": "| Sorting. Default value: `100` ||" }, "SUPPORTS_FFD105": { "type": "string", "description": "| Indicates whether the cashbox supports fiscal data format version 1.05. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Handler settings (detailed description provided below) ||" }, "PRINT_URL": { "type": "string", "description": "| Address to which data for printing the receipt is sent ||" }, "CHECK_URL": { "type": "string", "description": "| Address for checking the status of the receipt ||" }, "HTTP_VERSION": { "type": "string", "description": "| Version of the HTTP protocol used for requests. Possible values: `1.0`, `1.1`." }, "CONFIG": { "type": "object", "description": "| Structure of settings (detailed description provided below), which the user can set and modify on the cashbox editing page, as well as when adding or updating the cashbox via REST." }, "LABEL": { "type": "string", "description": "| Section header ||" }, "ITEMS": { "type": "object", "description": "| List of settings in the section (detailed description provided below)." }, "TYPE": { "type": "string", "description": "| Type of setting. Possible values:" }, "REQUIRED": { "type": "string", "description": "| Indicates whether the setting is required. Possible values:" }, "DISABLED": { "type": "string", "description": "| Indicates whether editing of the setting is disabled. Possible values:" }, "MULTIPLE": { "type": "string", "description": "| Indicates whether the setting is multiple. Possible values:" }, "MULTILINE": { "type": "string", "description": "| Indicates whether the field is multiline. Used for `STRING` type. Possible values:" }, "OPTIONS": { "type": "object", "description": "| List of possible values for the property. Used for `ENUM` type." }, "TIME": { "type": "string", "description": "| Indicates whether time selection is possible. Used for `DATE` type. Possible values:" } }, "required": [ "CODE", "NAME", "SETTINGS", "PRINT_URL", "CHECK_URL", "CONFIG", "LABEL", "ITEMS", "TYPE", "REQUIRED", "OPTIONS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.handler.delete": { "post": { "summary": "Delete Cashbox Handler sale.cashbox.handler.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the REST cashbox handler. If there are cashboxes linked to the handler, it will not be deleted — you must first remove the cashboxes.", "operationId": "sale_cashbox_handler_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cashbox handler to be deleted ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cashbox handler to be deleted ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.handler.list": { "post": { "summary": "Get a list of available cash register handlers sale.cashbox.handler.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of available REST cash register handlers. No parameters.", "operationId": "sale_cashbox_handler_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| List of handlers registered in the system ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| List of handlers registered in the system ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.handler.update": { "post": { "summary": "Update Cash Register Handler sale.cashbox.handler.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the data of the REST cash register handler.", "operationId": "sale_cashbox_handler_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the handler being updated ||" }, "FIELDS": { "type": "object", "description": "| Values of the fields to be updated." } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the handler being updated ||" }, "FIELDS": { "type": "object", "description": "| Values of the fields to be updated." } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.list": { "post": { "summary": "Get a list of configured cash registers sale.cashbox.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of configured cash registers.", "operationId": "sale_cashbox_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array with the list of fields to select (see fields of the sale_cashbox object) ||" }, "FILTER": { "type": "object", "description": "| An object for filtering selected cash registers in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting selected records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array with the list of fields to select (see fields of the sale_cashbox object) ||" }, "FILTER": { "type": "object", "description": "| An object for filtering selected cash registers in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting selected records in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.cashbox.update": { "post": { "summary": "Update Existing Cash Register sale.cashbox.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an existing cash register.", "operationId": "sale_cashbox_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cash register being updated ||" }, "FIELDS": { "type": "object", "description": "| Values of the fields to be updated (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the cash register ||" }, "EMAIL": { "type": "string", "description": "| Email address to which notifications will be sent in case of errors during receipt printing ||" }, "OFD": { "type": "string", "description": "| OFD handler code. Available OFD handlers:" }, "OFD_SETTINGS": { "type": "object", "description": "| OFD settings (detailed description provided below)" }, "NUMBER_KKM": { "type": "string", "description": "| External identifier of the cash register ||" }, "ACTIVE": { "type": "string", "description": "with value `Y/N` | Activity status of the cash register. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "USE_OFFLINE": { "type": "string", "description": "| Whether the cash register is used offline. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Cash register settings according to the structure of settings passed in the `CONFIG` key of the `SETTINGS` field of the sale.cashbox.handler.add method ||" }, "OFD_MODE": { "type": "object", "description": "| Settings related to the OFD operation mode. The `IS_TEST` parameter (`string` with values `Y/N`) is passed — OFD operation mode:" }, "SELLER_INFO": { "type": "object", "description": "| Settings for the \"Seller Information\" section. The required parameter `INN` (`string`) is passed — seller's INN" }, "AUTH": { "type": "object", "description": "| Authorization settings. The `INN` parameter (`string`) is passed — security key" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the cash register being updated ||" }, "FIELDS": { "type": "object", "description": "| Values of the fields to be updated (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the cash register ||" }, "EMAIL": { "type": "string", "description": "| Email address to which notifications will be sent in case of errors during receipt printing ||" }, "OFD": { "type": "string", "description": "| OFD handler code. Available OFD handlers:" }, "OFD_SETTINGS": { "type": "object", "description": "| OFD settings (detailed description provided below)" }, "NUMBER_KKM": { "type": "string", "description": "| External identifier of the cash register ||" }, "ACTIVE": { "type": "string", "description": "with value `Y/N` | Activity status of the cash register. Possible values:" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "USE_OFFLINE": { "type": "string", "description": "| Whether the cash register is used offline. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Cash register settings according to the structure of settings passed in the `CONFIG` key of the `SETTINGS` field of the sale.cashbox.handler.add method ||" }, "OFD_MODE": { "type": "object", "description": "| Settings related to the OFD operation mode. The `IS_TEST` parameter (`string` with values `Y/N`) is passed — OFD operation mode:" }, "SELLER_INFO": { "type": "object", "description": "| Settings for the \"Seller Information\" section. The required parameter `INN` (`string`) is passed — seller's INN" }, "AUTH": { "type": "object", "description": "| Authorization settings. The `INN` parameter (`string`) is passed — security key" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, cashbox" ] } ] } }, "/sale.delivery.add": { "post": { "summary": "Add Delivery Service sale.delivery.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a delivery service.", "operationId": "sale_delivery_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler (see the `CODE` field of the `sale_delivery_handler` object). ||" }, "NAME": { "type": "string", "description": "| Name of the delivery service ||" }, "CURRENCY": { "type": "string", "description": "| Symbolic code of the delivery service currency ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the delivery service's activity." }, "CONFIG": { "type": "string", "description": "| Values of the delivery service settings (detailed description provided below)." }, "LOGOTYPE": { "type": "string", "description": "| Logo of the delivery service (base64-encoded string) ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the setting ||" }, "VALUE": { "type": "string", "description": "| Value of the setting ||" } }, "required": [ "REST_CODE", "NAME", "CURRENCY", "CODE", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REST_CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler (see the `CODE` field of the `sale_delivery_handler` object). ||" }, "NAME": { "type": "string", "description": "| Name of the delivery service ||" }, "CURRENCY": { "type": "string", "description": "| Symbolic code of the delivery service currency ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the delivery service's activity." }, "CONFIG": { "type": "string", "description": "| Values of the delivery service settings (detailed description provided below)." }, "LOGOTYPE": { "type": "string", "description": "| Logo of the delivery service (base64-encoded string) ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the setting ||" }, "VALUE": { "type": "string", "description": "| Value of the setting ||" } }, "required": [ "REST_CODE", "NAME", "CURRENCY", "CODE", "VALUE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.config.get": { "post": { "summary": "Get Delivery Service Settings sale.delivery.config.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the settings of the delivery service.", "operationId": "sale_delivery_config_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-config-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.config.update": { "post": { "summary": "Update Delivery Service Settings sale.delivery.config.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the delivery service settings.", "operationId": "sale_delivery_config_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-config-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." }, "CONFIG": { "type": "string", "description": "| Values of the delivery service settings (detailed description provided below)." }, "CODE": { "type": "string", "description": "| Symbolic code of the setting ||" }, "VALUE": { "type": "string", "description": "| Value of the setting ||" } }, "required": [ "ID", "CODE", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." }, "CONFIG": { "type": "string", "description": "| Values of the delivery service settings (detailed description provided below)." }, "CODE": { "type": "string", "description": "| Symbolic code of the setting ||" }, "VALUE": { "type": "string", "description": "| Value of the setting ||" } }, "required": [ "ID", "CODE", "VALUE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.delete": { "post": { "summary": "Delete Delivery Service sale.delivery.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a delivery service.", "operationId": "sale_delivery_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.extra.service.add": { "post": { "summary": "Add Delivery Service sale.delivery.extra.service.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a delivery service.", "operationId": "sale_delivery_extra_service_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the created service will be linked." }, "TYPE": { "type": "string", "description": "| Type of service. Possible values:" }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of service activity. Possible values:" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the service ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Cost of the service in the currency of the delivery service." }, "ITEMS": { "type": "string", "description": "| List of available options for selection (detailed description provided below)." }, "TITLE": { "type": "string", "description": "| Name of the list option ||" } }, "required": [ "DELIVERY_ID", "TYPE", "NAME", "ITEMS", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the created service will be linked." }, "TYPE": { "type": "string", "description": "| Type of service. Possible values:" }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of service activity. Possible values:" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the service ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Cost of the service in the currency of the delivery service." }, "ITEMS": { "type": "string", "description": "| List of available options for selection (detailed description provided below)." }, "TITLE": { "type": "string", "description": "| Name of the list option ||" } }, "required": [ "DELIVERY_ID", "TYPE", "NAME", "ITEMS", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.extra.service.delete": { "post": { "summary": "Delete the delivery service sale.delivery.extra.service.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a delivery service.", "operationId": "sale_delivery_extra_service_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the service." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.extra.service.get": { "post": { "summary": "Get Information About All Services of a Specific Delivery Service sale.delivery.extra.service.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves information about all services of a specific delivery service.", "operationId": "sale_delivery_extra_service_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service ||" } }, "required": [ "DELIVERY_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service ||" } }, "required": [ "DELIVERY_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.extra.service.update": { "post": { "summary": "Update Delivery Service sale.delivery.extra.service.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the delivery service.", "operationId": "sale_delivery_extra_service_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the service." }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the service's activity. Possible values:" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the service ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Cost of the service in the delivery service's currency." }, "ITEMS": { "type": "string", "description": "| List of available options for selection (detailed description provided below)." }, "TITLE": { "type": "string", "description": "| Name of the list option ||" } }, "required": [ "ID", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the service." }, "NAME": { "type": "string", "description": "| Name of the service ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the service's activity. Possible values:" }, "CODE": { "type": "string", "description": "| Symbolic code of the service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the service ||" }, "PRICE": { "type": "number", "format": "double", "description": "| Cost of the service in the delivery service's currency." }, "ITEMS": { "type": "string", "description": "| List of available options for selection (detailed description provided below)." }, "TITLE": { "type": "string", "description": "| Name of the list option ||" } }, "required": [ "ID", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.getlist": { "post": { "summary": "Get a list of delivery services sale.delivery.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of delivery services.", "operationId": "sale_delivery_getlist", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object `sale_delivery_service`)." }, "FILTER": { "type": "object", "description": "| An object for filtering the selected delivery services in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the selected delivery services in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object `sale_delivery_service`)." }, "FILTER": { "type": "object", "description": "| An object for filtering the selected delivery services in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the selected delivery services in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.handler.add": { "post": { "summary": "Add Delivery Service Handler sale.delivery.handler.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a delivery service handler.", "operationId": "sale_delivery_handler_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the delivery service handler ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "integer", "description": "| Description of the delivery service handler ||" }, "SETTINGS": { "type": "object", "description": "| Object containing information about the settings of the delivery service handler (detailed description provided below) ||" }, "PROFILES": { "type": "string", "description": "| Array containing a list of delivery profile objects (detailed description provided below)." }, "CALCULATE_URL": { "type": "string", "description": "| URL for calculating delivery cost." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for creating a delivery order." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for canceling a delivery order." }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Type of the setting field" }, "OPTIONS": { "type": "object", "description": "| List of options for selection. Object in the format `key=value`. Where key is the option code, and value is the option." } }, "required": [ "NAME", "CODE", "SETTINGS", "PROFILES", "CALCULATE_URL", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the delivery service handler ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "integer", "description": "| Description of the delivery service handler ||" }, "SETTINGS": { "type": "object", "description": "| Object containing information about the settings of the delivery service handler (detailed description provided below) ||" }, "PROFILES": { "type": "string", "description": "| Array containing a list of delivery profile objects (detailed description provided below)." }, "CALCULATE_URL": { "type": "string", "description": "| URL for calculating delivery cost." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for creating a delivery order." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for canceling a delivery order." }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Type of the setting field" }, "OPTIONS": { "type": "object", "description": "| List of options for selection. Object in the format `key=value`. Where key is the option code, and value is the option." } }, "required": [ "NAME", "CODE", "SETTINGS", "PROFILES", "CALCULATE_URL", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.handler.delete": { "post": { "summary": "Delete Delivery Service Handler sale.delivery.handler.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the delivery service handler.", "operationId": "sale_delivery_handler_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service handler ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service handler ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.handler.list": { "post": { "summary": "Get a list of delivery service handlers sale.delivery.handler.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of delivery service handlers. No parameters.", "operationId": "sale_delivery_handler_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Array of objects with information about the selected delivery service handlers ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Array of objects with information about the selected delivery service handlers ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.handler.update": { "post": { "summary": "Update Delivery Service Handler sale.delivery.handler.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the delivery service handler.", "operationId": "sale_delivery_handler_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service handler." }, "NAME": { "type": "string", "description": "| Name of the delivery service handler ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service handler ||" }, "SETTINGS": { "type": "object", "description": "| An object containing information about the settings of the delivery service handler (detailed description provided below) ||" }, "PROFILES": { "type": "string", "description": "| An array containing a list of delivery profile objects (detailed description provided below)." }, "CALCULATE_URL": { "type": "string", "description": "| URL for calculating delivery cost." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for creating a delivery order." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for canceling a delivery order." }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Type of the setting field" }, "OPTIONS": { "type": "object", "description": "| List of options for selection. An object in the format `key=value`. Where the key is the option code, and the value is the option." } }, "required": [ "ID", "CALCULATE_URL", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service handler." }, "NAME": { "type": "string", "description": "| Name of the delivery service handler ||" }, "CODE": { "type": "string", "description": "| Symbolic code of the delivery service handler ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service handler ||" }, "SETTINGS": { "type": "object", "description": "| An object containing information about the settings of the delivery service handler (detailed description provided below) ||" }, "PROFILES": { "type": "string", "description": "| An array containing a list of delivery profile objects (detailed description provided below)." }, "CALCULATE_URL": { "type": "string", "description": "| URL for calculating delivery cost." }, "CREATE_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for creating a delivery order." }, "CANCEL_DELIVERY_REQUEST_URL": { "type": "string", "description": "| URL for canceling a delivery order." }, "HAS_CALLBACK_TRACKING_SUPPORT": { "type": "string", "description": "| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`)." }, "TYPE": { "type": "string", "description": "| Type of the setting field" }, "OPTIONS": { "type": "object", "description": "| List of options for selection. An object in the format `key=value`. Where the key is the option code, and the value is the option." } }, "required": [ "ID", "CALCULATE_URL", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.delivery.request.delete": { "post": { "summary": "Delete Delivery Request sale.delivery.request.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a delivery request.", "operationId": "sale_delivery_request_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the delivery request belongs." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." } }, "required": [ "DELIVERY_ID", "REQUEST_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the delivery request belongs." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." } }, "required": [ "DELIVERY_ID", "REQUEST_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.request.sendmessage": { "post": { "summary": "Create Notifications for Delivery Request sale.delivery.request.sendmessage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates notifications for a delivery request.", "operationId": "sale_delivery_request_sendmessage", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service related to the delivery request." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." }, "ADDRESSEE": { "type": "string", "description": "| Recipient of the message." }, "MESSAGE": { "type": "object", "description": "| Message (detailed description provided below)" }, "SUBJECT": { "type": "string", "description": "| Subject of the message." }, "BODY": { "type": "string", "description": "| Body of the message." }, "STATUS": { "type": "object", "description": "| Status of the message (detailed description provided below)" }, "MONEY_VALUES": { "type": "object", "description": "| Object in the format `key => value`." }, "SEMANTIC": { "type": "string", "description": "| Value of the status semantics." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "ADDRESSEE", "MESSAGE", "SUBJECT", "BODY", "SEMANTIC" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service related to the delivery request." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." }, "ADDRESSEE": { "type": "string", "description": "| Recipient of the message." }, "MESSAGE": { "type": "object", "description": "| Message (detailed description provided below)" }, "SUBJECT": { "type": "string", "description": "| Subject of the message." }, "BODY": { "type": "string", "description": "| Body of the message." }, "STATUS": { "type": "object", "description": "| Status of the message (detailed description provided below)" }, "MONEY_VALUES": { "type": "object", "description": "| Object in the format `key => value`." }, "SEMANTIC": { "type": "string", "description": "| Value of the status semantics." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "ADDRESSEE", "MESSAGE", "SUBJECT", "BODY", "SEMANTIC" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.request.update": { "post": { "summary": "Update Delivery Request sale.delivery.request.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the delivery request.", "operationId": "sale_delivery_request_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the delivery request belongs." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." }, "FINALIZE": { "type": "string", "description": "| Indicator of the need to finalize the delivery request." }, "STATUS": { "type": "object", "description": "| Status of the delivery request (detailed description provided below) ||" }, "PROPERTIES": { "type": "string", "description": "| Properties of the delivery request (detailed description provided below) ||" }, "OVERWRITE_PROPERTIES": { "type": "string", "description": "| Indicator of the need to completely overwrite the property values of the request during the update." }, "TEXT": { "type": "string", "description": "| Text name of the delivery request status ||" }, "SEMANTIC": { "type": "string", "description": "| Semantic value of the status." }, "NAME": { "type": "string", "description": "| Name of the property ||" }, "VALUE": { "type": "string", "description": "| Value of the property ||" }, "TAGS": { "type": "string", "description": "| List of tags." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "TEXT", "SEMANTIC", "NAME", "VALUE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DELIVERY_ID": { "type": "string", "description": "| Identifier of the delivery service to which the delivery request belongs." }, "REQUEST_ID": { "type": "string", "description": "| Identifier of the delivery request." }, "FINALIZE": { "type": "string", "description": "| Indicator of the need to finalize the delivery request." }, "STATUS": { "type": "object", "description": "| Status of the delivery request (detailed description provided below) ||" }, "PROPERTIES": { "type": "string", "description": "| Properties of the delivery request (detailed description provided below) ||" }, "OVERWRITE_PROPERTIES": { "type": "string", "description": "| Indicator of the need to completely overwrite the property values of the request during the update." }, "TEXT": { "type": "string", "description": "| Text name of the delivery request status ||" }, "SEMANTIC": { "type": "string", "description": "| Semantic value of the status." }, "NAME": { "type": "string", "description": "| Name of the property ||" }, "VALUE": { "type": "string", "description": "| Value of the property ||" }, "TAGS": { "type": "string", "description": "| List of tags." } }, "required": [ "DELIVERY_ID", "REQUEST_ID", "TEXT", "SEMANTIC", "NAME", "VALUE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale, delivery" ] } ] } }, "/sale.delivery.update": { "post": { "summary": "Update Delivery Service sale.delivery.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the delivery service.", "operationId": "sale_delivery_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." }, "NAME": { "type": "string", "description": "| Name of the delivery service ||" }, "CURRENCY": { "type": "string", "description": "| Currency symbol code of the delivery service ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the delivery service's activity." }, "LOGOTYPE": { "type": "string", "description": "| Logo of the delivery service (base64-encoded string) ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the delivery service." }, "NAME": { "type": "string", "description": "| Name of the delivery service ||" }, "CURRENCY": { "type": "string", "description": "| Currency symbol code of the delivery service ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the delivery service ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the delivery service's activity." }, "LOGOTYPE": { "type": "string", "description": "| Logo of the delivery service (base64-encoded string) ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.add": { "post": { "summary": "Add Order sale.order.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.order.add` is designed for adding an order.", "operationId": "sale_order_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an order ||" }, "lid": { "type": "string", "description": "| Identifier of the site where this payer type will be used. Has a constant value 's1' ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "currency": { "type": "string", "description": "| Currency. The list of currencies can be obtained via the method crm.currency.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Discount value ||" }, "statusId": { "type": "string", "description": "| Identifier of the order status ||" }, "empStatusId": { "type": "string", "description": "| Identifier of the user who changed the order status ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Order creation date ||" }, "marked": { "type": "string", "description": "| Marking flag. Indicates whether the shipment is marked as problematic. The value `Y` is set automatically if an error occurred during saving." }, "empMarkedId": { "type": "string", "description": "| Identifier of the user who set the marking ||" }, "reasonMarked": { "type": "string", "description": "| Reason for marking the order ||" }, "userDescription": { "type": "string", "description": "| Customer's comment on the order ||" }, "additionalInfo": { "type": "string", "description": "| Deprecated." }, "comments": { "type": "string", "description": "| Manager's comment on the order ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the order ||" }, "recurringId": { "type": "integer", "description": "| Identifier for subscription renewal ||" }, "lockedBy": { "type": "string", "description": "| Relevant only for on-premise." }, "recountFlag": { "type": "string", "description": "| Deprecated." }, "affiliateId": { "type": "integer", "description": "| Relevant only for on-premise." }, "updated1c": { "type": "string", "description": "| Updated via QuickBooks and other similar platforms." }, "orderTopic": { "type": "string", "description": "| Deprecated." }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "id1c": { "type": "string", "description": "| Identifier in QuickBooks and other similar platforms ||" }, "version1c": { "type": "string", "description": "| Version in QuickBooks and other similar platforms ||" }, "externalOrder": { "type": "string", "description": "| Whether the order is from an external system." }, "canceled": { "type": "string", "description": "| Whether the order was canceled." }, "empCanceledId": { "type": "string", "description": "| Identifier of the user who canceled the order ||" }, "reasonCanceled": { "type": "string", "description": "| Reason for cancellation ||" }, "userId": { "type": "string", "description": "| Identifier of the client ||" } }, "required": [ "fields", "lid", "personTypeId", "currency" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an order ||" }, "lid": { "type": "string", "description": "| Identifier of the site where this payer type will be used. Has a constant value 's1' ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "currency": { "type": "string", "description": "| Currency. The list of currencies can be obtained via the method crm.currency.list ||" }, "price": { "type": "number", "format": "double", "description": "| Price ||" }, "discountValue": { "type": "number", "format": "double", "description": "| Discount value ||" }, "statusId": { "type": "string", "description": "| Identifier of the order status ||" }, "empStatusId": { "type": "string", "description": "| Identifier of the user who changed the order status ||" }, "dateInsert": { "type": "string", "format": "date-time", "description": "| Order creation date ||" }, "marked": { "type": "string", "description": "| Marking flag. Indicates whether the shipment is marked as problematic. The value `Y` is set automatically if an error occurred during saving." }, "empMarkedId": { "type": "string", "description": "| Identifier of the user who set the marking ||" }, "reasonMarked": { "type": "string", "description": "| Reason for marking the order ||" }, "userDescription": { "type": "string", "description": "| Customer's comment on the order ||" }, "additionalInfo": { "type": "string", "description": "| Deprecated." }, "comments": { "type": "string", "description": "| Manager's comment on the order ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the order ||" }, "recurringId": { "type": "integer", "description": "| Identifier for subscription renewal ||" }, "lockedBy": { "type": "string", "description": "| Relevant only for on-premise." }, "recountFlag": { "type": "string", "description": "| Deprecated." }, "affiliateId": { "type": "integer", "description": "| Relevant only for on-premise." }, "updated1c": { "type": "string", "description": "| Updated via QuickBooks and other similar platforms." }, "orderTopic": { "type": "string", "description": "| Deprecated." }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "id1c": { "type": "string", "description": "| Identifier in QuickBooks and other similar platforms ||" }, "version1c": { "type": "string", "description": "| Version in QuickBooks and other similar platforms ||" }, "externalOrder": { "type": "string", "description": "| Whether the order is from an external system." }, "canceled": { "type": "string", "description": "| Whether the order was canceled." }, "empCanceledId": { "type": "string", "description": "| Identifier of the user who canceled the order ||" }, "reasonCanceled": { "type": "string", "description": "| Reason for cancellation ||" }, "userId": { "type": "string", "description": "| Identifier of the client ||" } }, "required": [ "fields", "lid", "personTypeId", "currency" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.delete": { "post": { "summary": "Delete Order and Related Objects sale.order.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `sale.order.delete` method is designed to delete an order and its related objects.", "operationId": "sale_order_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.get": { "post": { "summary": "Get Order Field Values and Related Objects sale.order.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.order.get` is designed to retrieve values for all fields of an order and related objects.", "operationId": "sale_order_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.getfields": { "post": { "summary": "Get Order Fields sale.order.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.order.getfields` retrieves the available fields of an order. No parameters.", "operationId": "sale_order_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "order": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_order object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "order": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_order object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.list": { "post": { "summary": "Get the list of orders sale.order.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.order.list` retrieves a list of orders.", "operationId": "sale_order_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the sale_order object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected orders in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected orders in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the sale_order object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected orders in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected orders in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.order.update": { "post": { "summary": "Update Order sale.order.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.order.update` updates the fields of an order.", "operationId": "sale_order_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the order ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Order identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the order ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.add": { "post": { "summary": "Add Payment sale.payment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new payment.", "operationId": "sale_payment_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment in the form of a structure:" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "paySystemId": { "type": "string", "description": "| Payment system identifier ||" }, "paid": { "type": "string", "description": "| Payment status:" }, "datePaid": { "type": "string", "format": "date-time", "description": "| Payment date ||" }, "empPaidId": { "type": "string", "description": "| Identifier of the user who made the payment ||" }, "psStatus": { "type": "string", "description": "| Payment system status flag — whether the payment was successful. Options:" }, "psStatusCode": { "type": "string", "description": "| Payment system status code ||" }, "psStatusDescription": { "type": "string", "description": "| Description of the payment system's result ||" }, "psStatusMessage": { "type": "string", "description": "| Message from the payment system ||" }, "psSum": { "type": "number", "format": "double", "description": "| Payment system amount ||" }, "psCurrency": { "type": "string", "description": "| Payment system currency ||" }, "psResponseDate": { "type": "string", "format": "date-time", "description": "| Payment system response date ||" }, "payVoucherNum": { "type": "string", "description": "| Payment document number ||" }, "payVoucherDate": { "type": "string", "format": "date-time", "description": "| Payment document date ||" }, "datePayBefore": { "type": "string", "format": "date-time", "description": "| Deprecated." }, "dateBill": { "type": "string", "format": "date-time", "description": "| Invoice date ||" }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "sum": { "type": "number", "format": "double", "description": "| Payment amount ||" }, "companyId": { "type": "integer", "description": "| Identifier of the company that will receive the payment" }, "payReturnNum": { "type": "string", "description": "| Return document number ||" }, "priceCod": { "type": "number", "format": "double", "description": "| Relevant only for on-premise version" }, "payReturnDate": { "type": "string", "format": "date", "description": "| Return document date ||" }, "empReturnId": { "type": "string", "description": "| Identifier of the user who processed the return ||" }, "payReturnComment": { "type": "string", "description": "| Return comment ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the payment ||" }, "empResponsibleId": { "type": "string", "description": "| Identifier of the user who assigned the responsible person ||" }, "isReturn": { "type": "string", "description": "| Was the return processed:" }, "comments": { "type": "string", "description": "| Payment comments ||" }, "updated1c": { "type": "string", "description": "| Payment updated via QuickBooks and other similar platforms:" }, "id1c": { "type": "string", "description": "| Identifier in QuickBooks and other similar platforms ||" }, "version1c": { "type": "string", "description": "| Payment document version from QuickBooks and other similar platforms ||" }, "externalPayment": { "type": "string", "description": "| Relevant only for on-premise version" }, "psInvoiceId": { "type": "string", "description": "| Payment identifier in the payment system ||" }, "marked": { "type": "string", "description": "| Marking flag. Indicates whether the payment is marked as problematic:" }, "reasonMarked": { "type": "string", "description": "| Reason for marking ||" }, "empMarkedId": { "type": "string", "description": "| Identifier of the user who marked the payment ||" } }, "required": [ "fields", "orderId", "paySystemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment in the form of a structure:" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "paySystemId": { "type": "string", "description": "| Payment system identifier ||" }, "paid": { "type": "string", "description": "| Payment status:" }, "datePaid": { "type": "string", "format": "date-time", "description": "| Payment date ||" }, "empPaidId": { "type": "string", "description": "| Identifier of the user who made the payment ||" }, "psStatus": { "type": "string", "description": "| Payment system status flag — whether the payment was successful. Options:" }, "psStatusCode": { "type": "string", "description": "| Payment system status code ||" }, "psStatusDescription": { "type": "string", "description": "| Description of the payment system's result ||" }, "psStatusMessage": { "type": "string", "description": "| Message from the payment system ||" }, "psSum": { "type": "number", "format": "double", "description": "| Payment system amount ||" }, "psCurrency": { "type": "string", "description": "| Payment system currency ||" }, "psResponseDate": { "type": "string", "format": "date-time", "description": "| Payment system response date ||" }, "payVoucherNum": { "type": "string", "description": "| Payment document number ||" }, "payVoucherDate": { "type": "string", "format": "date-time", "description": "| Payment document date ||" }, "datePayBefore": { "type": "string", "format": "date-time", "description": "| Deprecated." }, "dateBill": { "type": "string", "format": "date-time", "description": "| Invoice date ||" }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "sum": { "type": "number", "format": "double", "description": "| Payment amount ||" }, "companyId": { "type": "integer", "description": "| Identifier of the company that will receive the payment" }, "payReturnNum": { "type": "string", "description": "| Return document number ||" }, "priceCod": { "type": "number", "format": "double", "description": "| Relevant only for on-premise version" }, "payReturnDate": { "type": "string", "format": "date", "description": "| Return document date ||" }, "empReturnId": { "type": "string", "description": "| Identifier of the user who processed the return ||" }, "payReturnComment": { "type": "string", "description": "| Return comment ||" }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the payment ||" }, "empResponsibleId": { "type": "string", "description": "| Identifier of the user who assigned the responsible person ||" }, "isReturn": { "type": "string", "description": "| Was the return processed:" }, "comments": { "type": "string", "description": "| Payment comments ||" }, "updated1c": { "type": "string", "description": "| Payment updated via QuickBooks and other similar platforms:" }, "id1c": { "type": "string", "description": "| Identifier in QuickBooks and other similar platforms ||" }, "version1c": { "type": "string", "description": "| Payment document version from QuickBooks and other similar platforms ||" }, "externalPayment": { "type": "string", "description": "| Relevant only for on-premise version" }, "psInvoiceId": { "type": "string", "description": "| Payment identifier in the payment system ||" }, "marked": { "type": "string", "description": "| Marking flag. Indicates whether the payment is marked as problematic:" }, "reasonMarked": { "type": "string", "description": "| Reason for marking ||" }, "empMarkedId": { "type": "string", "description": "| Identifier of the user who marked the payment ||" } }, "required": [ "fields", "orderId", "paySystemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.delete": { "post": { "summary": "Delete Payment sale.payment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a payment.", "operationId": "sale_payment_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.get": { "post": { "summary": "Get Payment by Id sale.payment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the values of all payment fields by `Id`.", "operationId": "sale_payment_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.getFields": { "post": { "summary": "Get Payment Fields sale.payment.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available payment fields. No parameters.", "operationId": "sale_payment_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "payment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object sale_order_payment, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "payment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object sale_order_payment, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.list": { "post": { "summary": "Get the list of payments sale.payment.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of payments.", "operationId": "sale_payment_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "filter": { "type": "object", "description": "| An object for filtering the selected payments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "result": { "type": "object", "description": "| The root element of the response ||" }, "payments": { "type": "string", "description": "| An array of objects containing information about the selected payments ||" }, "total": { "type": "integer", "description": "| The total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "filter": { "type": "object", "description": "| An object for filtering the selected payments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." }, "result": { "type": "object", "description": "| The root element of the response ||" }, "payments": { "type": "string", "description": "| An array of objects containing information about the selected payments ||" }, "total": { "type": "integer", "description": "| The total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.payment.update": { "post": { "summary": "Update Payment sale.payment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.payment.update` is used to update fields of the payment collection item.", "operationId": "sale_payment_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment in the form of a structure:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment in the form of a structure:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.add": { "post": { "summary": "Add Payment Binding to Shipment sale.paymentItemShipment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a payment binding to a shipment.", "operationId": "sale_paymentItemShipment_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment binding to a shipment in the form of a structure:" }, "shipmentId": { "type": "string", "description": "| Shipment identifier ||" }, "paymentId": { "type": "string", "description": "| Payment identifier ||" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "fields", "shipmentId", "paymentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a payment binding to a shipment in the form of a structure:" }, "shipmentId": { "type": "string", "description": "| Shipment identifier ||" }, "paymentId": { "type": "string", "description": "| Payment identifier ||" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "fields", "shipmentId", "paymentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.delete": { "post": { "summary": "Remove the binding sale.paymentItemShipment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.paymentItemShipment.delete` removes the payment binding to the shipment.", "operationId": "sale_paymentItemShipment_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.get": { "post": { "summary": "Get Payment Binding by Id sale.paymentItemShipment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the payment binding to the shipment by `ID`.", "operationId": "sale_paymentItemShipment_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.getFields": { "post": { "summary": "Get Fields for sale.paymentItemShipment.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available fields of the payment item shipment binding table. No parameters.", "operationId": "sale_paymentItemShipment_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "paymentItemShipment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_payment_item_shipment object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "paymentItemShipment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_payment_item_shipment object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.list": { "post": { "summary": "Get a list of bindings sale.paymentItemShipment.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of payment bindings to shipments based on a filter.", "operationId": "sale_paymentItemShipment_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the sale_payment_item_shipment object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payment bindings to shipments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to be selected (see fields of the sale_payment_item_shipment object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payment bindings to shipments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentItemShipment.update": { "post": { "summary": "Change Payment Binding to Shipment sale.paymentItemShipment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the binding of payment to shipment.", "operationId": "sale_paymentItemShipment_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating the payment binding to the shipment in the form of a structure:" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payment binding to the shipment ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating the payment binding to the shipment in the form of a structure:" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.add": { "post": { "summary": "Add Basket Item Binding to Payment sale.paymentitembasket.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a binding of a basket item to a payment.", "operationId": "sale_paymentitembasket_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a binding of a basket item to a payment ||" }, "paymentId": { "type": "string", "description": "| Payment identifier ||" }, "basketId": { "type": "string", "description": "| Basket item identifier ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External record identifier ||" } }, "required": [ "fields", "paymentId", "basketId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a binding of a basket item to a payment ||" }, "paymentId": { "type": "string", "description": "| Payment identifier ||" }, "basketId": { "type": "string", "description": "| Basket item identifier ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External record identifier ||" } }, "required": [ "fields", "paymentId", "basketId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.delete": { "post": { "summary": "Delete the binding of the cart item to the payment sale.paymentitembasket.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the binding of a cart item to a payment.", "operationId": "sale_paymentitembasket_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the binding of the cart item to the payment" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the binding of the cart item to the payment" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.get": { "post": { "summary": "Get Values of All Fields for the Basket Item Binding to Payment sale.paymentitembasket.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the values of all fields for the basket item binding to payment.", "operationId": "sale_paymentitembasket_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item binding to payment ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the basket item binding to payment ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.getfields": { "post": { "summary": "Get Available Fields for Payment Item Basket Bindings sale.paymentitembasket.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available fields for payment item basket bindings. No parameters.", "operationId": "sale_paymentitembasket_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "paymentItemBasket": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the sale_payment_item_basket object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "paymentItemBasket": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the sale_payment_item_basket object, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.list": { "post": { "summary": "Get a list of basket item bindings to payments sale.paymentitembasket.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of bindings of basket items to payments.", "operationId": "sale_paymentitembasket_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with the list of fields to be selected (see fields of the sale_payment_item_basket object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings of basket items to payments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bindings of basket items to payments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array with the list of fields to be selected (see fields of the sale_payment_item_basket object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected bindings of basket items to payments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected bindings of basket items to payments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paymentitembasket.update": { "post": { "summary": "Update the binding of the cart item to the payment sale.paymentitembasket.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the binding of the cart item to the payment.", "operationId": "sale_paymentitembasket_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the binding of the cart item to the payment ||" }, "fields": { "type": "object", "description": "| Field values for updating the binding of the cart item to the payment ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the binding of the cart item to the payment ||" }, "fields": { "type": "object", "description": "| Field values for updating the binding of the cart item to the payment ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier of the record ||" } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.paysystem.add": { "post": { "summary": "Add Payment System sale.paysystem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a payment system.", "operationId": "sale_paysystem_add", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the payment system ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the payment system ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the payment system's activity. Possible values:" }, "SETTINGS": { "type": "object", "description": "| List of handler settings values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the name of the setting and `value` is an object containing keys TYPE and VALUE (see description below)." }, "ENTITY_REGISTRY_TYPE": { "type": "string", "description": "| Binding of the payment system:" }, "LOGOTYPE": { "type": "string", "description": "| Logo of the payment system (image in Base64 format) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Flag for the \"Open in new window\" setting. Possible values:" }, "XML_ID": { "type": "string", "description": "| External identifier of the payment system. Can be used as an additional parameter for filtering in sale.paysystem.list ||" }, "Name": { "type": "string", "description": "| Description ||" }, "ORDER": { "type": "string", "description": "| Parameters ||" }, "PROPERTY": { "type": "string", "description": "| Invoice properties ||" }, "PAYMENT": { "type": "string", "description": "| Payment ||" }, "USER": { "type": "string", "description": "| User ||" }, "VALUE": { "type": "string", "description": "| Arbitrary string value ||" } }, "required": [ "NAME", "PERSON_TYPE_ID", "BX_REST_HANDLER", "ENTITY_REGISTRY_TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the payment system ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the payment system ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the payment system's activity. Possible values:" }, "SETTINGS": { "type": "object", "description": "| List of handler settings values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the name of the setting and `value` is an object containing keys TYPE and VALUE (see description below)." }, "ENTITY_REGISTRY_TYPE": { "type": "string", "description": "| Binding of the payment system:" }, "LOGOTYPE": { "type": "string", "description": "| Logo of the payment system (image in Base64 format) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Flag for the \"Open in new window\" setting. Possible values:" }, "XML_ID": { "type": "string", "description": "| External identifier of the payment system. Can be used as an additional parameter for filtering in sale.paysystem.list ||" }, "Name": { "type": "string", "description": "| Description ||" }, "ORDER": { "type": "string", "description": "| Parameters ||" }, "PROPERTY": { "type": "string", "description": "| Invoice properties ||" }, "PAYMENT": { "type": "string", "description": "| Payment ||" }, "USER": { "type": "string", "description": "| User ||" }, "VALUE": { "type": "string", "description": "| Arbitrary string value ||" } }, "required": [ "NAME", "PERSON_TYPE_ID", "BX_REST_HANDLER", "ENTITY_REGISTRY_TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.delete": { "post": { "summary": "Delete Payment System sale.paysystem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a payment system.", "operationId": "sale_paysystem_delete", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.add": { "post": { "summary": "Add REST Handler for Payment System sale.paysystem.handler.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so the assistant can use the official REST documentation. This method adds a REST handler for the payment system.", "operationId": "sale_paysystem_handler_add", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-handler-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the REST handler ||" }, "SORT": { "type": "integer", "description": "| Sorting order. Default is `100` ||" }, "CODE": { "type": "string", "description": "| Code of the REST handler. Must be unique among all handlers ||" }, "SETTINGS": { "type": "object", "description": "| Handler settings (detailed description provided below) ||" }, "CODES": { "type": "object", "description": "| List of handler parameters. Keys are parameter codes (`string`), values are parameter descriptions (detailed description provided below)." }, "FORM_DATA": { "type": "object", "description": "| Form settings when using the operating mode in form ||" }, "CHECKOUT_DATA": { "type": "object", "description": "| Settings for the Checkout mode (creating an order on the service side and redirecting the buyer to this page for payment) ||" }, "IFRAME_DATA": { "type": "object", "description": "| Settings for the page displayed in the iframe on the seller's site on the payment page ||" }, "CLIENT_TYPE": { "type": "string", "description": "| Type of buyers that the handler can work with. Available values:" }, "CURRENCY": { "type": "string", "description": "| List of currencies supported by the payment system. Default is empty ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the parameter ||" }, "GROUP": { "type": "string", "description": "| Code of the group to which the parameter belongs ||" }, "DEFAULT": { "type": "object", "description": "| Description of the default value (detailed description provided below)" }, "INPUT": { "type": "object", "description": "| Object describing the input field. The structure of the object contains the `TYPE` parameter — the type of the field. Supported fields:" }, "PROVIDER_KEY": { "type": "string", "description": "| Key of the provider from which the default value will be taken. Possible key values are listed below ||" }, "PROVIDER_VALUE": { "type": "string", "description": "| Code of the value that will be taken from the provider. Possible key values are listed below ||" }, "Name": { "type": "string", "description": "| Description ||" }, "ORDER": { "type": "string", "description": "| Order ||" }, "PROPERTY": { "type": "string", "description": "| Invoice properties ||" }, "PAYMENT": { "type": "string", "description": "| Payment ||" }, "USER": { "type": "string", "description": "| User ||" }, "VALUE": { "type": "string", "description": "| Arbitrary string type value ||" } }, "required": [ "NAME", "CODE", "SETTINGS", "CODES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NAME": { "type": "string", "description": "| Name of the REST handler ||" }, "SORT": { "type": "integer", "description": "| Sorting order. Default is `100` ||" }, "CODE": { "type": "string", "description": "| Code of the REST handler. Must be unique among all handlers ||" }, "SETTINGS": { "type": "object", "description": "| Handler settings (detailed description provided below) ||" }, "CODES": { "type": "object", "description": "| List of handler parameters. Keys are parameter codes (`string`), values are parameter descriptions (detailed description provided below)." }, "FORM_DATA": { "type": "object", "description": "| Form settings when using the operating mode in form ||" }, "CHECKOUT_DATA": { "type": "object", "description": "| Settings for the Checkout mode (creating an order on the service side and redirecting the buyer to this page for payment) ||" }, "IFRAME_DATA": { "type": "object", "description": "| Settings for the page displayed in the iframe on the seller's site on the payment page ||" }, "CLIENT_TYPE": { "type": "string", "description": "| Type of buyers that the handler can work with. Available values:" }, "CURRENCY": { "type": "string", "description": "| List of currencies supported by the payment system. Default is empty ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the parameter ||" }, "GROUP": { "type": "string", "description": "| Code of the group to which the parameter belongs ||" }, "DEFAULT": { "type": "object", "description": "| Description of the default value (detailed description provided below)" }, "INPUT": { "type": "object", "description": "| Object describing the input field. The structure of the object contains the `TYPE` parameter — the type of the field. Supported fields:" }, "PROVIDER_KEY": { "type": "string", "description": "| Key of the provider from which the default value will be taken. Possible key values are listed below ||" }, "PROVIDER_VALUE": { "type": "string", "description": "| Code of the value that will be taken from the provider. Possible key values are listed below ||" }, "Name": { "type": "string", "description": "| Description ||" }, "ORDER": { "type": "string", "description": "| Order ||" }, "PROPERTY": { "type": "string", "description": "| Invoice properties ||" }, "PAYMENT": { "type": "string", "description": "| Payment ||" }, "USER": { "type": "string", "description": "| User ||" }, "VALUE": { "type": "string", "description": "| Arbitrary string type value ||" } }, "required": [ "NAME", "CODE", "SETTINGS", "CODES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.delete": { "post": { "summary": "Delete the REST handler for the payment system sale.paysystem.handler.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method deletes the REST handler for the payment system.", "operationId": "sale_paysystem_handler_delete", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-handler-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the REST handler ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the REST handler ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.list": { "post": { "summary": "Get a List of REST Handlers for the Payment System sale.paysystem.handler.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of REST handlers for the payment system. No parameters required.", "operationId": "sale_paysystem_handler_list", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-handler-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| List of registered REST handlers for payment systems ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| List of registered REST handlers for payment systems ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description | Status ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.handler.update": { "post": { "summary": "Update REST Handler for Payment System sale.paysystem.handler.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the REST handler for the payment system.", "operationId": "sale_paysystem_handler_update", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-handler-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the REST handler ||" }, "FIELDS": { "type": "object", "description": "| Set of values for updating (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the handler ||" }, "CODE": { "type": "string", "description": "| Unique code of the handler in the system ||" }, "SETTINGS": { "type": "object", "description": "| Handler settings. The format is similar to that in sale.paysystem.handler.add ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "ID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the REST handler ||" }, "FIELDS": { "type": "object", "description": "| Set of values for updating (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the handler ||" }, "CODE": { "type": "string", "description": "| Unique code of the handler in the system ||" }, "SETTINGS": { "type": "object", "description": "| Handler settings. The format is similar to that in sale.paysystem.handler.add ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "ID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.list": { "post": { "summary": "Get a List of Payment Systems sale.paysystem.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method returns a list of payment systems.", "operationId": "sale_paysystem_list", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the `sale_paysystem` object)." }, "FILTER": { "type": "object", "description": "| An object for filtering the selected payment systems in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the selected payment systems in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SELECT": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the `sale_paysystem` object)." }, "FILTER": { "type": "object", "description": "| An object for filtering the selected payment systems in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "ORDER": { "type": "object", "description": "| An object for sorting the selected payment systems in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.pay.invoice": { "post": { "summary": "Pay Invoice Through a Specific Payment System sale.paysystem.pay.invoice", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is used to pay an invoice (legacy version) through a specific payment system. It is called after processing the response from the payment system.", "operationId": "sale_paysystem_pay_invoice", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/outdated/sale-pay-system-pay-invoice.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve invoice information." }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Identifier of the payment system" }, "BX_REST_HANDLER": { "type": "string", "description": "| Symbolic identifier of the REST handler for the payment system." } }, "required": [ "INVOICE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve invoice information." }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Identifier of the payment system" }, "BX_REST_HANDLER": { "type": "string", "description": "| Symbolic identifier of the REST handler for the payment system." } }, "required": [ "INVOICE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.pay.payment": { "post": { "summary": "Pay for an Order via a Specific Payment System sale.paysystem.pay.payment", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is used to pay for an order through a specific payment system. It is called after processing the response from the payment system. To perform the payment, there must be a payment associated with the specified payment system in the system.", "operationId": "sale_paysystem_pay_payment", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-pay-payment.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Payment identifier" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Payment identifier" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.get": { "post": { "summary": "Get Payment System Settings sale.paysystem.settings.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method returns the settings of the payment system. The structure of the settings is defined when adding the payment system handler in the method [sale.paysystem.handler.add](./sale-pay-system-handler-add.md) under the `CODES` key of the `SETTINGS` parameter.", "operationId": "sale_paysystem_settings_get", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-settings-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system for which settings are to be retrieved" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type for which settings are to be retrieved. To get default settings, pass `0`" } }, "required": [ "ID", "PERSON_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system for which settings are to be retrieved" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type for which settings are to be retrieved. To get default settings, pass `0`" } }, "required": [ "ID", "PERSON_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.invoice.get": { "post": { "summary": "Get Payment System Settings for a Specific Invoice sale.paysystem.settings.invoice.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method returns the payment system settings for a specific invoice (legacy version).", "operationId": "sale_paysystem_settings_invoice_get", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/outdated/sale-pay-system-settings-invoice-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve information about invoices." }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Identifier of the payment system" }, "BX_REST_HANDLER": { "type": "string", "description": "| Symbolic identifier of the payment system handler" } }, "required": [ "INVOICE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "INVOICE_ID": { "type": "integer", "description": "| Identifier of the legacy invoice. The service crm.invoice.* is used to retrieve information about invoices." }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Identifier of the payment system" }, "BX_REST_HANDLER": { "type": "string", "description": "| Symbolic identifier of the payment system handler" } }, "required": [ "INVOICE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.payment.get": { "post": { "summary": "Get Payment System Settings for a Specific Payment sale.paysystem.settings.payment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method returns the payment system settings for a specific payment.", "operationId": "sale_paysystem_settings_payment_get", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-settings-payment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Payment identifier" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PAYMENT_ID": { "type": "string", "description": "| Payment identifier" }, "PAY_SYSTEM_ID": { "type": "string", "description": "| Payment system identifier" } }, "required": [ "PAYMENT_ID", "PAY_SYSTEM_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.settings.update": { "post": { "summary": "Update Payment System Settings sale.paysystem.settings.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the payment system settings. The structure of the settings is defined when adding the payment system handler in the method [sale.paysystem.handler.add](./sale-pay-system-handler-add.md) under the `CODES` key of the `SETTINGS` parameter.", "operationId": "sale_paysystem_settings_update", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-settings-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system for which settings need to be retrieved" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type for which settings need to be retrieved" }, "SETTINGS": { "type": "object", "description": "| Settings to be updated. The keys are the names of the settings, and the values are objects whose structure is described below" }, "TYPE": { "type": "string", "description": "| Source of the parameter value ||" }, "VALUE": { "type": "string", "description": "| Parameter code at the source or parameter value (for `TYPE=\"VALUE\"`) ||" } }, "required": [ "ID", "SETTINGS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system for which settings need to be retrieved" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type for which settings need to be retrieved" }, "SETTINGS": { "type": "object", "description": "| Settings to be updated. The keys are the names of the settings, and the values are objects whose structure is described below" }, "TYPE": { "type": "string", "description": "| Source of the parameter value ||" }, "VALUE": { "type": "string", "description": "| Parameter code at the source or parameter value (for `TYPE=\"VALUE\"`) ||" } }, "required": [ "ID", "SETTINGS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.paysystem.update": { "post": { "summary": "Update Payment System sale.paysystem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the payment system.", "operationId": "sale_paysystem_update", "tags": [ "Payment Systems" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/pay-system/sale-pay-system-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system ||" }, "FIELDS": { "type": "object", "description": "| Object containing new field values (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the payment system ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the payment system ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the payment system's activity. Possible values:" }, "LOGOTYPE": { "type": "string", "description": "| Logo of the payment system (image in Base64 format) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Flag for the \"Open in new window\" setting. Possible values:" }, "XML_ID": { "type": "string", "description": "| External identifier of the payment system ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "string", "description": "| Identifier of the payment system ||" }, "FIELDS": { "type": "object", "description": "| Object containing new field values (detailed description provided below) ||" }, "NAME": { "type": "string", "description": "| Name of the payment system ||" }, "DESCRIPTION": { "type": "string", "description": "| Description of the payment system ||" }, "PERSON_TYPE_ID": { "type": "string", "description": "| Identifier of the payer type ||" }, "BX_REST_HANDLER": { "type": "string", "description": "| Code of the REST handler specified when adding the handler using the sale.paysystem.handler.add method ||" }, "ACTIVE": { "type": "string", "description": "| Indicator of the payment system's activity. Possible values:" }, "LOGOTYPE": { "type": "string", "description": "| Logo of the payment system (image in Base64 format) ||" }, "NEW_WINDOW": { "type": "string", "description": "| Flag for the \"Open in new window\" setting. Possible values:" }, "XML_ID": { "type": "string", "description": "| External identifier of the payment system ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "pay_system" ] } ] } }, "/sale.persontype.add": { "post": { "summary": "Add payer type sale.persontype.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new payer type.", "operationId": "sale_persontype_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a new payer type in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the payer type ||" }, "code": { "type": "string", "description": "| Code of the payer type. Must be unique ||" }, "sort": { "type": "string", "description": "| Sorting. Default value is `150` ||" }, "active": { "type": "string", "description": "| Active flag. Can take values `Y` / `N`. Default is set to `Y` ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for creating a new payer type in the form of a structure:" }, "name": { "type": "string", "description": "| Name of the payer type ||" }, "code": { "type": "string", "description": "| Code of the payer type. Must be unique ||" }, "sort": { "type": "string", "description": "| Sorting. Default value is `150` ||" }, "active": { "type": "string", "description": "| Active flag. Can take values `Y` / `N`. Default is set to `Y` ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.delete": { "post": { "summary": "Delete payer type sale.persontype.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a payer type.", "operationId": "sale_persontype_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payer type ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the payer type ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.get": { "post": { "summary": "Get the payer type by Id sale.persontype.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is used to access the fields of the payer type by its `Id`.", "operationId": "sale_persontype_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| The payer type number ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| The payer type number ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.getFields": { "post": { "summary": "Get Fields of the Payer Type sale.persontype.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns fields of the payer type. No parameters.", "operationId": "sale_persontype_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "personType": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value\"}`." }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "personType": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value\"}`." }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.list": { "post": { "summary": "Get a list of payer types sale.persontype.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of payer types. Use the `sale.persontype.list` method when creating a payment system **for orders**. In CRM (for old invoices, deals), the list of payer types is retrieved using the [crm.persontype.list](../../crm/outdated/invoice/crm-person-type-list.md) method.", "operationId": "sale_persontype_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_person_type object)" }, "filter": { "type": "object", "description": "| An object for filtering the selected payer types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payer types in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_person_type object)" }, "filter": { "type": "object", "description": "| An object for filtering the selected payer types in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payer types in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.persontype.update": { "post": { "summary": "Change the payer type sale.persontype.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method modifies the fields of the payer type.", "operationId": "sale_persontype_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| The ID of the payer type ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the payer type field in the form of a structure:" }, "name": { "type": "string", "description": "| The name of the payer type ||" }, "code": { "type": "string", "description": "| The code of the payer type. Must be unique ||" }, "sort": { "type": "string", "description": "| Sorting. Default value is `150` ||" }, "active": { "type": "string", "description": "| Activity flag. Can take values `Y` / `N`. Default is set to `Y` ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "id", "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| The ID of the payer type ||" }, "fields": { "type": "object", "description": "| Field values (detailed description provided below) for updating the payer type field in the form of a structure:" }, "name": { "type": "string", "description": "| The name of the payer type ||" }, "code": { "type": "string", "description": "| The code of the payer type. Must be unique ||" }, "sort": { "type": "string", "description": "| Sorting. Default value is `150` ||" }, "active": { "type": "string", "description": "| Activity flag. Can take values `Y` / `N`. Default is set to `Y` ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "id", "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.add": { "post": { "summary": "Add Order Property sale.property.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds an order property.", "operationId": "sale_property_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an order property ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "propsGroupId": { "type": "string", "description": "| Identifier of the property group ||" }, "name": { "type": "string", "description": "| Name of the order property ||" }, "type": { "type": "string", "description": "| Type of the order property." }, "code": { "type": "string", "description": "| Symbolic code of the order property ||" }, "active": { "type": "string", "description": "| Indicator of the order property’s activity." }, "util": { "type": "string", "description": "| Indicator of whether the order property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the order property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the order property is available in the filter on the order list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the order property ||" }, "required": { "type": "string", "description": "| Indicator of whether the order property value is required." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, several values can be specified." }, "xmlId": { "type": "string", "description": "| External identifier of the order property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the order property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the order property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for calculating shipping costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address from which the order needs to be picked up for calculating shipping costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address to which the order needs to be delivered for calculating shipping costs." }, "minlength": { "type": "integer", "description": "| Minimum allowable length (number of characters) of the order property value ||" }, "maxlength": { "type": "integer", "description": "| Maximum allowable length (number of characters) of the order property value ||" }, "pattern": { "type": "string", "description": "| Regular expression for validating the order property value." }, "multiline": { "type": "string", "description": "| Indicator of whether to display a multiline input field for the property value. Possible values:" }, "cols": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "rows": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "size": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "min": { "type": "integer", "description": "| Minimum allowable value for this order property ||" }, "max": { "type": "integer", "description": "| Maximum allowable value for this order property ||" }, "step": { "type": "integer", "description": "| Step for changing the value. Used in some user interfaces for convenience in changing the order property value ||" }, "multielement": { "type": "string", "description": "| Indicator of whether to display the order property as a list of checkboxes." }, "maxsize": { "type": "integer", "description": "| Maximum allowable size of the uploaded file in bytes ||" }, "accept": { "type": "string", "description": "| List of file extensions that are allowed to be uploaded for this order property value. Example: png, doc, zip ||" }, "time": { "type": "string", "description": "| Indicator of whether to add the option to select time when working with the value of this order property. Value is used in some user interfaces." } }, "required": [ "fields", "personTypeId", "propsGroupId", "name", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an order property ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "propsGroupId": { "type": "string", "description": "| Identifier of the property group ||" }, "name": { "type": "string", "description": "| Name of the order property ||" }, "type": { "type": "string", "description": "| Type of the order property." }, "code": { "type": "string", "description": "| Symbolic code of the order property ||" }, "active": { "type": "string", "description": "| Indicator of the order property’s activity." }, "util": { "type": "string", "description": "| Indicator of whether the order property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the order property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the order property is available in the filter on the order list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the order property ||" }, "required": { "type": "string", "description": "| Indicator of whether the order property value is required." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, several values can be specified." }, "xmlId": { "type": "string", "description": "| External identifier of the order property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the order property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the order property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for calculating shipping costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address from which the order needs to be picked up for calculating shipping costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address to which the order needs to be delivered for calculating shipping costs." }, "minlength": { "type": "integer", "description": "| Minimum allowable length (number of characters) of the order property value ||" }, "maxlength": { "type": "integer", "description": "| Maximum allowable length (number of characters) of the order property value ||" }, "pattern": { "type": "string", "description": "| Regular expression for validating the order property value." }, "multiline": { "type": "string", "description": "| Indicator of whether to display a multiline input field for the property value. Possible values:" }, "cols": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "rows": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "size": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "min": { "type": "integer", "description": "| Minimum allowable value for this order property ||" }, "max": { "type": "integer", "description": "| Maximum allowable value for this order property ||" }, "step": { "type": "integer", "description": "| Step for changing the value. Used in some user interfaces for convenience in changing the order property value ||" }, "multielement": { "type": "string", "description": "| Indicator of whether to display the order property as a list of checkboxes." }, "maxsize": { "type": "integer", "description": "| Maximum allowable size of the uploaded file in bytes ||" }, "accept": { "type": "string", "description": "| List of file extensions that are allowed to be uploaded for this order property value. Example: png, doc, zip ||" }, "time": { "type": "string", "description": "| Indicator of whether to add the option to select time when working with the value of this order property. Value is used in some user interfaces." } }, "required": [ "fields", "personTypeId", "propsGroupId", "name", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.delete": { "post": { "summary": "Delete Order Property sale.property.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an order property.", "operationId": "sale_property_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.get": { "post": { "summary": "Get Order Property sale.property.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the order property.", "operationId": "sale_property_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.getfieldsbytype": { "post": { "summary": "Get Fields and Settings of Order Properties for a Specific Property Type sale.property.getfieldsbytype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method retrieves the available fields of order properties by property type.", "operationId": "sale_property_getfieldsbytype", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-get-fields-by-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Order property type" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Order property type" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.list": { "post": { "summary": "Get the list of order properties sale.property.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of order properties.", "operationId": "sale_property_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the sale_order_property object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected items in the shipment table in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the sale_order_property object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected items in the shipment table in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.property.update": { "post": { "summary": "Update Order Property sale.property.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the order property.", "operationId": "sale_property_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" }, "fields": { "type": "object", "description": "| Field values for creating the order property ||" }, "name": { "type": "string", "description": "| Name of the order property ||" }, "code": { "type": "string", "description": "| Symbolic code of the order property ||" }, "active": { "type": "string", "description": "| Indicator of the order property’s activity." }, "util": { "type": "string", "description": "| Indicator of whether the order property is a service property. Service properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the order property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the order property is available in the filter on the order list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the order property ||" }, "required": { "type": "string", "description": "| Indicator of whether filling in the order property value is mandatory." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the order property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the order property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the order property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during checkout)." }, "isPhone": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used. ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address from where the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address where the order needs to be delivered for calculating delivery costs." } }, "required": [ "id", "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property ||" }, "fields": { "type": "object", "description": "| Field values for creating the order property ||" }, "name": { "type": "string", "description": "| Name of the order property ||" }, "code": { "type": "string", "description": "| Symbolic code of the order property ||" }, "active": { "type": "string", "description": "| Indicator of the order property’s activity." }, "util": { "type": "string", "description": "| Indicator of whether the order property is a service property. Service properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the order property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the order property is available in the filter on the order list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the order property ||" }, "required": { "type": "string", "description": "| Indicator of whether filling in the order property value is mandatory." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the order property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the order property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the order property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during checkout)." }, "isPhone": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether to use the value of this order property as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether to use the value of this order property as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used. ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address from where the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether to use the value of this order property as the buyer's address where the order needs to be delivered for calculating delivery costs." } }, "required": [ "id", "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.add": { "post": { "summary": "Add Property Binding sale.propertyRelation.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.propertyRelation.add` adds a property binding.", "operationId": "sale_propertyRelation_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property binding ||" }, "entityId": { "type": "integer", "description": "| Identifier of the object ||" }, "entityType": { "type": "string", "description": "| Type of the object:" }, "propertyId": { "type": "string", "description": "| Identifier of the property ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property binding ||" }, "entityId": { "type": "integer", "description": "| Identifier of the object ||" }, "entityType": { "type": "string", "description": "| Type of the object:" }, "propertyId": { "type": "string", "description": "| Identifier of the property ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.deleteByFilter": { "post": { "summary": "Remove Property Relation with sale.propertyRelation.deleteByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.propertyRelation.deleteByFilter` removes the property relation.", "operationId": "sale_propertyRelation_deleteByFilter", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-delete-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for removing the property relation ||" }, "entityId": { "type": "integer", "description": "| Entity identifier ||" }, "entityType": { "type": "string", "description": "| Entity type:" }, "propertyId": { "type": "string", "description": "| Property identifier ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for removing the property relation ||" }, "entityId": { "type": "integer", "description": "| Entity identifier ||" }, "entityType": { "type": "string", "description": "| Entity type:" }, "propertyId": { "type": "string", "description": "| Property identifier ||" } }, "required": [ "fields", "entityId", "entityType", "propertyId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.getFields": { "post": { "summary": "Get Fields of Property Binding sale.propertyRelation.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.propertyRelation.getFields` allows access to the available fields of property binding.", "operationId": "sale_propertyRelation_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyRelation.list": { "post": { "summary": "Get a list of property bindings sale.propertyRelation.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.propertyRelation.list` allows you to retrieve a list of property bindings.", "operationId": "sale_propertyRelation_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select (see fields of the object sale_order_property_relation)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property bindings in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property bindings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| The array contains a list of fields to select (see fields of the object sale_order_property_relation)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property bindings in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property bindings in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| The parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.add": { "post": { "summary": "Create Property Group sale.propertygroup.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a property group.", "operationId": "sale_propertygroup_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property group ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "name": { "type": "string", "description": "| Name of the property group ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "personTypeId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property group ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "name": { "type": "string", "description": "| Name of the property group ||" }, "sort": { "type": "integer", "description": "| Sorting ||" } }, "required": [ "fields", "personTypeId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.delete": { "post": { "summary": "Delete Property Group sale.propertygroup.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a property group.", "operationId": "sale_propertygroup_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.get": { "post": { "summary": "Get Values of All Fields in a Property Group by ID sale.propertygroup.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method allows you to retrieve the values of all fields in a property group.", "operationId": "sale_propertygroup_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.getFields": { "post": { "summary": "Get Available Fields of Property Groups sale.propertygroup.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is designed to retrieve the available fields of property groups. No parameters.", "operationId": "sale_propertygroup_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyGroup": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_order_property_group, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyGroup": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_order_property_group, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.list": { "post": { "summary": "Get a list of property groups sale.propertygroup.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method is designed to retrieve a list of property groups.", "operationId": "sale_propertygroup_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_order_property_group object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property groups in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property groups in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_order_property_group object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property groups in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property groups in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertygroup.update": { "post": { "summary": "Update Property Group Fields sale.propertygroup.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the fields of a property group.", "operationId": "sale_propertygroup_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" }, "fields": { "type": "object", "description": "| Field values for updating the property group ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property group ||" }, "fields": { "type": "object", "description": "| Field values for updating the property group ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.delete": { "post": { "summary": "Delete Order Property Value sale.propertyvalue.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the value of an order property.", "operationId": "sale_propertyvalue_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property value ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property value ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.get": { "post": { "summary": "Get Property Value with sale.propertyvalue.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the property value by its identifier.", "operationId": "sale_propertyvalue_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property value ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the order property value ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.getfields": { "post": { "summary": "Get Available Fields of the Property Value sale.propertyvalue.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method returns the available fields of the order property value options.", "operationId": "sale_propertyvalue_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.list": { "post": { "summary": "Get a list of property values sale.propertyvalue.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of order property value options.", "operationId": "sale_propertyvalue_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected (see fields of the sale_order_property_value object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected property values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected (see fields of the sale_order_property_value object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected property values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvalue.modify": { "post": { "summary": "Change the Value of the Property sale.propertyvalue.modify", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the property values of an order. **Please note** that this method accepts **all** property values of the order as input. If values for any properties are not provided, their current values will be removed from the order as a result of the request.", "operationId": "sale_propertyvalue_modify", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-modify.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The root element that transmits the request parameters in the form of a structure:" }, "order": { "type": "object", "description": "| An object containing the order ID and property values in the form of a structure:" }, "id": { "type": "string", "description": "| Order identifier ||" }, "propertyValues": { "type": "string", "description": "| An array of objects (see the description of the `propertyValues` object below), containing the order property identifier and property value ||" }, "orderPropsId": { "type": "string", "description": "| Order property identifier ||" }, "value": { "type": "string", "description": "| Order property value." } }, "required": [ "fields", "order", "id", "propertyValues", "orderPropsId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The root element that transmits the request parameters in the form of a structure:" }, "order": { "type": "object", "description": "| An object containing the order ID and property values in the form of a structure:" }, "id": { "type": "string", "description": "| Order identifier ||" }, "propertyValues": { "type": "string", "description": "| An array of objects (see the description of the `propertyValues` object below), containing the order property identifier and property value ||" }, "orderPropsId": { "type": "string", "description": "| Order property identifier ||" }, "value": { "type": "string", "description": "| Order property value." } }, "required": [ "fields", "order", "id", "propertyValues", "orderPropsId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.add": { "post": { "summary": "Add Property Variant sale.propertyvariant.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a variant value for a property. It is applicable only for properties of type `ENUM`.", "operationId": "sale_propertyvariant_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property variant ||" }, "orderPropsId": { "type": "string", "description": "| Property identifier ||" }, "name": { "type": "string", "description": "| Name of the property variant value ||" }, "value": { "type": "string", "description": "| Symbolic code of the property variant value ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the property variant value ||" } }, "required": [ "fields", "orderPropsId", "name", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a property variant ||" }, "orderPropsId": { "type": "string", "description": "| Property identifier ||" }, "name": { "type": "string", "description": "| Name of the property variant value ||" }, "value": { "type": "string", "description": "| Symbolic code of the property variant value ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the property variant value ||" } }, "required": [ "fields", "orderPropsId", "name", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.delete": { "post": { "summary": "Delete Property Variant sale.propertyvariant.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a property variant value of an order. It is applicable only for properties of type `ENUM`.", "operationId": "sale_propertyvariant_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property variant ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property variant ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.get": { "post": { "summary": "Get Property Variant Value by ID sale.propertyvariant.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the variant value of an order property. It is applicable only for properties of type `ENUM`.", "operationId": "sale_propertyvariant_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property variant ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property variant ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.getFields": { "post": { "summary": "Get Available Fields of Property Variant sale.propertyvariant.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of property value variants. No parameters.", "operationId": "sale_propertyvariant_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyVariant": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_order_property_variant, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyVariant": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_order_property_variant, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.list": { "post": { "summary": "Get a list of property variants sale.propertyvariant.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of property value variants. This method is applicable only for properties of type `ENUM`.", "operationId": "sale_propertyvariant_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected (see fields of the object sale_order_property_variant)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property value variants in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property value variants in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to be selected (see fields of the object sale_order_property_variant)." }, "filter": { "type": "object", "description": "| An object for filtering the selected property value variants in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected property value variants in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.propertyvariant.update": { "post": { "summary": "Update Property Variant Fields sale.propertyvariant.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the value variant of a property. It is applicable only for properties of type `ENUM`.", "operationId": "sale_propertyvariant_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property value variant ||" }, "fields": { "type": "object", "description": "| Field values to update the property value variant ||" }, "name": { "type": "string", "description": "| Name of the property value variant ||" }, "value": { "type": "string", "description": "| Value (code) of the property value variant ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the property value variant ||" } }, "required": [ "id", "fields", "name", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the property value variant ||" }, "fields": { "type": "object", "description": "| Field values to update the property value variant ||" }, "name": { "type": "string", "description": "| Name of the property value variant ||" }, "value": { "type": "string", "description": "| Value (code) of the property value variant ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the property value variant ||" } }, "required": [ "id", "fields", "name", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.add": { "post": { "summary": "Add Shipment sale.shipment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a shipment.", "operationId": "sale_shipment_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a shipment ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "allowDelivery": { "type": "string", "description": "| Delivery permission indicator" }, "deducted": { "type": "string", "description": "| Indicator of whether the shipment has been shipped" }, "deliveryId": { "type": "string", "description": "| Delivery service identifier ||" }, "statusId": { "type": "string", "description": "| Delivery status identifier" }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Shipment document date ||" }, "deliveryDocNum": { "type": "string", "description": "| Shipment document number ||" }, "trackingNumber": { "type": "string", "description": "| Shipment identifier ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Base delivery cost (without discounts / surcharges)." }, "comments": { "type": "string", "description": "| Manager's comment ||" }, "companyId": { "type": "integer", "description": "| Company identifier from the \"Online Store\" module." }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the shipment ||" }, "xmlId": { "type": "string", "description": "| External shipment identifier." } }, "required": [ "fields", "orderId", "allowDelivery", "deducted", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a shipment ||" }, "orderId": { "type": "string", "description": "| Order identifier ||" }, "allowDelivery": { "type": "string", "description": "| Delivery permission indicator" }, "deducted": { "type": "string", "description": "| Indicator of whether the shipment has been shipped" }, "deliveryId": { "type": "string", "description": "| Delivery service identifier ||" }, "statusId": { "type": "string", "description": "| Delivery status identifier" }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Shipment document date ||" }, "deliveryDocNum": { "type": "string", "description": "| Shipment document number ||" }, "trackingNumber": { "type": "string", "description": "| Shipment identifier ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Base delivery cost (without discounts / surcharges)." }, "comments": { "type": "string", "description": "| Manager's comment ||" }, "companyId": { "type": "integer", "description": "| Company identifier from the \"Online Store\" module." }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the shipment ||" }, "xmlId": { "type": "string", "description": "| External shipment identifier." } }, "required": [ "fields", "orderId", "allowDelivery", "deducted", "deliveryId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.delete": { "post": { "summary": "Delete Shipment sale.shipment.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a shipment.", "operationId": "sale_shipment_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.get": { "post": { "summary": "Get Shipment Fields sale.shipment.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the values of all shipment fields.", "operationId": "sale_shipment_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Shipment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Shipment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.getfields": { "post": { "summary": "Get Available Shipment Fields sale.shipment.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available shipment fields. No parameters.", "operationId": "sale_shipment_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "shipment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_shipment`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "shipment": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_shipment`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.list": { "post": { "summary": "Get the list of shipments sale.shipment.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of shipments.", "operationId": "sale_shipment_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_shipment object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payment bindings to shipments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_shipment object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected payment bindings to shipments in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected payment bindings to shipments in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipment.update": { "post": { "summary": "Update Shipment sale.shipment.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a shipment.", "operationId": "sale_shipment_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Shipment identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment ||" }, "allowDelivery": { "type": "string", "description": "| Indicator of delivery permission." }, "deducted": { "type": "string", "description": "| Indicator of whether the shipment has been shipped." }, "deliveryId": { "type": "string", "description": "| Delivery service identifier ||" }, "statusId": { "type": "string", "description": "| Delivery status identifier." }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Shipment document date ||" }, "deliveryDocNum": { "type": "string", "description": "| Shipment document number ||" }, "trackingNumber": { "type": "string", "description": "| Shipment identifier ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Base delivery cost (without discounts / surcharges)." }, "priceDelivery": { "type": "number", "format": "double", "description": "| Delivery cost." }, "comments": { "type": "string", "description": "| Manager's comment ||" }, "companyId": { "type": "integer", "description": "| Company identifier from the \"Online Store\" module." }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the shipment ||" }, "xmlId": { "type": "string", "description": "| External shipment identifier." } }, "required": [ "id", "fields", "allowDelivery", "deducted", "deliveryId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Shipment identifier ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment ||" }, "allowDelivery": { "type": "string", "description": "| Indicator of delivery permission." }, "deducted": { "type": "string", "description": "| Indicator of whether the shipment has been shipped." }, "deliveryId": { "type": "string", "description": "| Delivery service identifier ||" }, "statusId": { "type": "string", "description": "| Delivery status identifier." }, "deliveryDocDate": { "type": "string", "format": "date-time", "description": "| Shipment document date ||" }, "deliveryDocNum": { "type": "string", "description": "| Shipment document number ||" }, "trackingNumber": { "type": "string", "description": "| Shipment identifier ||" }, "basePriceDelivery": { "type": "number", "format": "double", "description": "| Base delivery cost (without discounts / surcharges)." }, "priceDelivery": { "type": "number", "format": "double", "description": "| Delivery cost." }, "comments": { "type": "string", "description": "| Manager's comment ||" }, "companyId": { "type": "integer", "description": "| Company identifier from the \"Online Store\" module." }, "responsibleId": { "type": "string", "description": "| Identifier of the user responsible for the shipment ||" }, "xmlId": { "type": "string", "description": "| External shipment identifier." } }, "required": [ "id", "fields", "allowDelivery", "deducted", "deliveryId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.add": { "post": { "summary": "Add an item to the shipment table part sale.shipmentitem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.shipmentitem.add` adds an item to the shipment table part.", "operationId": "sale_shipmentitem_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item in the shipment table part ||" }, "orderDeliveryId": { "type": "string", "description": "| Shipment identifier ||" }, "basketId": { "type": "string", "description": "| Basket identifier ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "fields", "orderDeliveryId", "basketId", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating an item in the shipment table part ||" }, "orderDeliveryId": { "type": "string", "description": "| Shipment identifier ||" }, "basketId": { "type": "string", "description": "| Basket identifier ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "fields", "orderDeliveryId", "basketId", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.delete": { "post": { "summary": "Delete Shipment Item from Collection sale.shipmentitem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.shipmentitem.delete` removes an item from the shipment's table part.", "operationId": "sale_shipmentitem_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment table item ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment table item ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.get": { "post": { "summary": "Accessing Fields of the sale.shipmentitem.get Element", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `sale.shipmentitem.get` method is designed to retrieve the values of all fields of the shipment item table element.", "operationId": "sale_shipmentitem_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment item table element ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment item table element ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.getfields": { "post": { "summary": "Get Fields of Shipment Item from sale.shipmentitem.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.shipmentitem.getfields` allows you to retrieve a list of available fields for shipment item table entries. No parameters required.", "operationId": "sale_shipmentitem_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "shipmentItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_shipment_item`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "shipmentItem": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_shipment_item`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.list": { "post": { "summary": "Get a list of shipment item table elements sale.shipmentitem.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.shipmentitem.list` allows you to retrieve a list of shipment item table elements.", "operationId": "sale_shipmentitem_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object sale_order_shipment_item)." }, "filter": { "type": "object", "description": "| An object for filtering the selected shipment item table elements in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected shipment item table elements in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the object sale_order_shipment_item)." }, "filter": { "type": "object", "description": "| An object for filtering the selected shipment item table elements in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected shipment item table elements in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentitem.update": { "post": { "summary": "Update an item in the shipment table part sale.shipmentitem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.shipmentitem.update` updates an item in the shipment table part collection.", "operationId": "sale_shipmentitem_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment table part item ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment table part item ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "id", "fields", "quantity" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment table part item ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment table part item ||" }, "quantity": { "type": "number", "format": "double", "description": "| Quantity of the product ||" }, "xmlId": { "type": "string", "description": "| External identifier." } }, "required": [ "id", "fields", "quantity" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.add": { "post": { "summary": "Add Shipment Property sale.shipmentproperty.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a shipment property.", "operationId": "sale_shipmentproperty_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a shipment property ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "propsGroupId": { "type": "string", "description": "| Identifier of the property group ||" }, "name": { "type": "string", "description": "| Name of the shipment property ||" }, "type": { "type": "string", "description": "| Type of the shipment property." }, "code": { "type": "string", "description": "| Symbolic code of the shipment property ||" }, "active": { "type": "string", "description": "| Indicator of the activity status of the shipment property." }, "util": { "type": "string", "description": "| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the shipment property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the shipment property is available in the filter on the shipment list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the shipment property ||" }, "required": { "type": "string", "description": "| Indicator of whether the value of the shipment property is required." }, "multiple": { "type": "string", "description": "| Indicator of whether the shipment property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the shipment property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the shipment property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the shipment property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address from which the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address to which the order needs to be delivered for calculating delivery costs." }, "minlength": { "type": "integer", "description": "| Minimum allowable length (number of characters) of the shipment property value ||" }, "maxlength": { "type": "integer", "description": "| Maximum allowable length (number of characters) of the shipment property value ||" }, "pattern": { "type": "string", "description": "| Regular expression for validating the shipment property value." }, "multiline": { "type": "string", "description": "| Indicator of whether to display a multiline input field for the shipment property value. Possible values:" }, "cols": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "rows": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "size": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "min": { "type": "integer", "description": "| Minimum allowable value for this shipment property ||" }, "max": { "type": "integer", "description": "| Maximum allowable value for this shipment property ||" }, "step": { "type": "integer", "description": "| Step for changing the value. Used in some user interfaces for convenience in changing the shipment property value ||" }, "multielement": { "type": "string", "description": "| Indicator of whether to display the shipment property as a list of checkboxes." }, "maxsize": { "type": "integer", "description": "| Maximum allowable size of the uploaded file in bytes ||" }, "accept": { "type": "string", "description": "| List of file extensions that are allowed to be uploaded as the value of this shipment property. Example: png, doc, zip ||" }, "time": { "type": "string", "description": "| Indicator of whether to add the option to select time when working with the value of this shipment property. Value is used in some user interfaces." } }, "required": [ "fields", "personTypeId", "propsGroupId", "name", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating a shipment property ||" }, "personTypeId": { "type": "string", "description": "| Identifier of the payer type ||" }, "propsGroupId": { "type": "string", "description": "| Identifier of the property group ||" }, "name": { "type": "string", "description": "| Name of the shipment property ||" }, "type": { "type": "string", "description": "| Type of the shipment property." }, "code": { "type": "string", "description": "| Symbolic code of the shipment property ||" }, "active": { "type": "string", "description": "| Indicator of the activity status of the shipment property." }, "util": { "type": "string", "description": "| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the shipment property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the shipment property is available in the filter on the shipment list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the shipment property ||" }, "required": { "type": "string", "description": "| Indicator of whether the value of the shipment property is required." }, "multiple": { "type": "string", "description": "| Indicator of whether the shipment property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the shipment property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the shipment property." }, "settings": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for the shipment property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the user profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address from which the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address to which the order needs to be delivered for calculating delivery costs." }, "minlength": { "type": "integer", "description": "| Minimum allowable length (number of characters) of the shipment property value ||" }, "maxlength": { "type": "integer", "description": "| Maximum allowable length (number of characters) of the shipment property value ||" }, "pattern": { "type": "string", "description": "| Regular expression for validating the shipment property value." }, "multiline": { "type": "string", "description": "| Indicator of whether to display a multiline input field for the shipment property value. Possible values:" }, "cols": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "rows": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "size": { "type": "integer", "description": "| Deprecated parameter. Not used ||" }, "min": { "type": "integer", "description": "| Minimum allowable value for this shipment property ||" }, "max": { "type": "integer", "description": "| Maximum allowable value for this shipment property ||" }, "step": { "type": "integer", "description": "| Step for changing the value. Used in some user interfaces for convenience in changing the shipment property value ||" }, "multielement": { "type": "string", "description": "| Indicator of whether to display the shipment property as a list of checkboxes." }, "maxsize": { "type": "integer", "description": "| Maximum allowable size of the uploaded file in bytes ||" }, "accept": { "type": "string", "description": "| List of file extensions that are allowed to be uploaded as the value of this shipment property. Example: png, doc, zip ||" }, "time": { "type": "string", "description": "| Indicator of whether to add the option to select time when working with the value of this shipment property. Value is used in some user interfaces." } }, "required": [ "fields", "personTypeId", "propsGroupId", "name", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.delete": { "post": { "summary": "Delete Shipment Property sale.shipmentproperty.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a shipment property.", "operationId": "sale_shipmentproperty_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.get": { "post": { "summary": "Get Shipment Property sale.shipmentproperty.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the shipment property.", "operationId": "sale_shipmentproperty_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.getfieldsbytype": { "post": { "summary": "Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available fields of shipment properties by property type.", "operationId": "sale_shipmentproperty_getfieldsbytype", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-get-fields-by-type.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Shipment property type" } }, "required": [ "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "| Shipment property type" } }, "required": [ "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.list": { "post": { "summary": "Get a list of shipment properties sale.shipmentproperty.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of shipment properties.", "operationId": "sale_shipmentproperty_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the sale_shipment_property object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected shipment properties in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected shipment properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see the fields of the sale_shipment_property object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected shipment properties in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected shipment properties in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentproperty.update": { "post": { "summary": "Update Shipment Property sale.shipmentproperty.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the shipment property.", "operationId": "sale_shipmentproperty_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment property ||" }, "name": { "type": "string", "description": "| Name of the shipment property ||" }, "code": { "type": "string", "description": "| Symbolic code of the shipment property ||" }, "active": { "type": "string", "description": "| Indicator of whether the shipment property is active." }, "util": { "type": "string", "description": "| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the shipment property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the shipment property is available in the filter on the shipment list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the shipment property ||" }, "required": { "type": "string", "description": "| Indicator of whether filling in the shipment property value is mandatory." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the shipment property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the shipment property." }, "settings": { "type": "object", "description": "| An object in the format {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"} for passing additional settings for the shipment property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the user's profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address from which the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address to which the order needs to be delivered for calculating delivery costs." } }, "required": [ "id", "fields", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property ||" }, "fields": { "type": "object", "description": "| Field values for updating the shipment property ||" }, "name": { "type": "string", "description": "| Name of the shipment property ||" }, "code": { "type": "string", "description": "| Symbolic code of the shipment property ||" }, "active": { "type": "string", "description": "| Indicator of whether the shipment property is active." }, "util": { "type": "string", "description": "| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part." }, "userProps": { "type": "string", "description": "| Indicator of whether the shipment property is included in the customer profile." }, "isFiltered": { "type": "string", "description": "| Indicator of whether the shipment property is available in the filter on the shipment list page." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "description": { "type": "string", "description": "| Description of the shipment property ||" }, "required": { "type": "string", "description": "| Indicator of whether filling in the shipment property value is mandatory." }, "multiple": { "type": "string", "description": "| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values." }, "xmlId": { "type": "string", "description": "| External identifier of the shipment property ||" }, "defaultValue": { "type": "string", "description": "| Default value of the shipment property." }, "settings": { "type": "object", "description": "| An object in the format {\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"} for passing additional settings for the shipment property." }, "isProfileName": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the user's profile name." }, "isPayer": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the payer's name." }, "isEmail": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement)." }, "isPhone": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a phone number." }, "isZip": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as a postal code." }, "isAddress": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as an address." }, "isLocation": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for calculating delivery costs." }, "isLocation4tax": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's location for determining tax rates." }, "inputFieldLocation": { "type": "string", "description": "| Deprecated field. Not used ||" }, "isAddressFrom": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address from which the order needs to be picked up for calculating delivery costs." }, "isAddressTo": { "type": "string", "description": "| Indicator of whether the value of this shipment property should be used as the customer's address to which the order needs to be delivered for calculating delivery costs." } }, "required": [ "id", "fields", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.delete": { "post": { "summary": "Delete Shipment Property Value sale.shipmentpropertyvalue.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the shipment property value.", "operationId": "sale_shipmentpropertyvalue_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-propertyvalue-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property value ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property value ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.get": { "post": { "summary": "Get Shipment Property Value by ID sale.shipmentpropertyvalue.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the values of the shipment property.", "operationId": "sale_shipmentpropertyvalue_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property value ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Identifier of the shipment property value ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.getfields": { "post": { "summary": "Get Available Fields of Shipment Property Values sale.shipmentpropertyvalue.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields of shipment property values. No parameters.", "operationId": "sale_shipmentpropertyvalue_getfields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyValue": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_shipment_property_value, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "propertyValue": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object sale_shipment_property_value, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.list": { "post": { "summary": "Get a list of shipment property values sale.shipmentpropertyvalue.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of shipment property values.", "operationId": "sale_shipmentpropertyvalue_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_shipment_property_value object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected property values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_shipment_property_value object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property values in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected property values in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.shipmentpropertyvalue.modify": { "post": { "summary": "Update Shipment Property Values sale.shipmentpropertyvalue.modify", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the shipment property values.", "operationId": "sale_shipmentpropertyvalue_modify", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-modify.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The root element that carries the request parameters ||" }, "shipment": { "type": "object", "description": "| The object containing the shipment ID and shipment property values (detailed description provided below) ||" }, "id": { "type": "string", "description": "| Shipment ID ||" }, "propertyValues": { "type": "string", "description": "| An array of objects containing the shipment property ID and property value (detailed description provided below) ||" }, "shipmentPropsId": { "type": "string", "description": "| Shipment property ID ||" }, "value": { "type": "string", "description": "| Property value ||" } }, "required": [ "fields", "shipment", "id", "propertyValues", "shipmentPropsId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| The root element that carries the request parameters ||" }, "shipment": { "type": "object", "description": "| The object containing the shipment ID and shipment property values (detailed description provided below) ||" }, "id": { "type": "string", "description": "| Shipment ID ||" }, "propertyValues": { "type": "string", "description": "| An array of objects containing the shipment property ID and property value (detailed description provided below) ||" }, "shipmentPropsId": { "type": "string", "description": "| Shipment property ID ||" }, "value": { "type": "string", "description": "| Property value ||" } }, "required": [ "fields", "shipment", "id", "propertyValues", "shipmentPropsId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.add": { "post": { "summary": "Create status sale.status.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a status for an order or delivery.", "operationId": "sale_status_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating the status ||" }, "id": { "type": "string", "description": "| Symbolic identifier of the status." }, "type": { "type": "string", "description": "| Type of status:" }, "notify": { "type": "string", "description": "| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "color": { "type": "string", "description": "| HEX color code of the status (e.g., `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| External code of the status." } }, "required": [ "fields", "id", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values for creating the status ||" }, "id": { "type": "string", "description": "| Symbolic identifier of the status." }, "type": { "type": "string", "description": "| Type of status:" }, "notify": { "type": "string", "description": "| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "color": { "type": "string", "description": "| HEX color code of the status (e.g., `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| External code of the status." } }, "required": [ "fields", "id", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.delete": { "post": { "summary": "Delete Status sale.status.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an order or delivery status.", "operationId": "sale_status_delete", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Status identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Status identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.get": { "post": { "summary": "Get Values of All Status Fields by ID sale.status.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the values of all fields of the status.", "operationId": "sale_status_get", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the status ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the status ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.list": { "post": { "summary": "Get the list of statuses sale.status.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of statuses.", "operationId": "sale_status_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_status object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property groups in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected statuses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array of fields to select (see fields of the sale_status object)." }, "filter": { "type": "object", "description": "| An object for filtering selected property groups in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting selected statuses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used to manage pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.status.update": { "post": { "summary": "Update status sale.status.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the status of an order or delivery.", "operationId": "sale_status_update", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "fields": { "type": "object", "description": "| Field values for updating the status ||" }, "type": { "type": "string", "description": "| Status type:" }, "notify": { "type": "string", "description": "| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "color": { "type": "string", "description": "| HEX color code of the status (e.g., `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| External code of the status." } }, "required": [ "id", "fields", "type" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "fields": { "type": "object", "description": "| Field values for updating the status ||" }, "type": { "type": "string", "description": "| Status type:" }, "notify": { "type": "string", "description": "| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status." }, "sort": { "type": "integer", "description": "| Sorting ||" }, "color": { "type": "string", "description": "| HEX color code of the status (e.g., `#FF0000`) ||" }, "xmlId": { "type": "string", "description": "| External code of the status." } }, "required": [ "id", "fields", "type" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.add": { "post": { "summary": "Add Localization sale.statusLang.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds localization for the order or delivery status.", "operationId": "sale_statusLang_add", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding status localization in the form of a structure:" }, "statusId": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "lid": { "type": "string", "description": "| Language identifier. Current possible values are listed below:" }, "name": { "type": "string", "description": "| Name of the status for the created localization ||" }, "description": { "type": "string", "description": "| Description of the status for the created localization ||" } }, "required": [ "fields", "statusId", "lid", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding status localization in the form of a structure:" }, "statusId": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "lid": { "type": "string", "description": "| Language identifier. Current possible values are listed below:" }, "name": { "type": "string", "description": "| Name of the status for the created localization ||" }, "description": { "type": "string", "description": "| Description of the status for the created localization ||" } }, "required": [ "fields", "statusId", "lid", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.deleteByFilter": { "post": { "summary": "Delete localization sale.statusLang.deleteByFilter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes the localization records of the order or delivery status by status ID and language.", "operationId": "sale_statusLang_deleteByFilter", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-delete-by-filter.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Values of the filter fields (detailed description provided below) for deleting the localization record in the form of a structure:" }, "statusId": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "lid": { "type": "string", "description": "| Language identifier. Current possible values are listed below:" }, "name": { "type": "string", "description": "|" } }, "required": [ "fields", "statusId", "lid", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Values of the filter fields (detailed description provided below) for deleting the localization record in the form of a structure:" }, "statusId": { "type": "string", "description": "| Symbolic identifier of the status ||" }, "lid": { "type": "string", "description": "| Language identifier. Current possible values are listed below:" }, "name": { "type": "string", "description": "|" } }, "required": [ "fields", "statusId", "lid", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.getFields": { "post": { "summary": "Get Localization Fields for Statuses sale.statusLang.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available localization fields for order or delivery statuses. No parameters.", "operationId": "sale_statusLang_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "statusLang": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_status_lang object, and value is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "statusLang": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the sale_status_lang object, and value is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.getListLangs": { "post": { "summary": "Get the list of languages for localization sale.statusLang.getListLangs", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of possible languages for localizations. No parameters.", "operationId": "sale_statusLang_getListLangs", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-get-list-langs.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "langs": { "type": "string", "description": "| Array of objects with information about selected languages ||" }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "langs": { "type": "string", "description": "| Array of objects with information about selected languages ||" }, "total": { "type": "integer", "description": "| Total number of records found ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.statusLang.list": { "post": { "summary": "Get a list of localizations for sale.statusLang.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves a list of localizations for order or delivery statuses.", "operationId": "sale_statusLang_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_status_lang object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected items in the shipment table part in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected statuses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_status_lang object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected items in the shipment table part in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "order": { "type": "object", "description": "| An object for sorting the selected statuses in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradeBinding.getFields": { "post": { "summary": "Get Available Order Fields from sale.tradeBinding.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.tradeBinding.getFields` returns the available order fields from sources. No parameters.", "operationId": "sale_tradeBinding_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/trade-binding/sale-trade-binding-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "tradeBinding": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_trade_binding`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "tradeBinding": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`, where `field` is the identifier of the object `sale_order_trade_binding`, and `value` is an object of type `rest_field_description` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradeBinding.list": { "post": { "summary": "Get a list of orders from sources sale.tradeBinding.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.tradeBinding.list` returns a list of orders from sources.", "operationId": "sale_tradeBinding_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/trade-binding/sale-trade-binding-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_trade_binding object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected orders in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. When multiple fields are specified, AND logic is used." }, "order": { "type": "object", "description": "| An object for sorting the selected orders in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_trade_binding object)." }, "filter": { "type": "object", "description": "| An object for filtering the selected orders in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. When multiple fields are specified, AND logic is used." }, "order": { "type": "object", "description": "| An object for sorting the selected orders in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradePlatform.getFields": { "post": { "summary": "Get Available Fields of Order Sources sale.tradePlatform.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.tradePlatform.getFields` returns the available fields of order sources. No parameters.", "operationId": "sale_tradePlatform_getFields", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/trade-platform/sale-trade-platform-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "tradePlatform": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object sale_order_trade_platform, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "tradePlatform": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. Where `field` is the identifier of the object sale_order_trade_platform, and `value` is an object of type rest_field_description ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" }, "Code": { "type": "string", "description": "| Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/sale.tradePlatform.list": { "post": { "summary": "Get a List of Order Sources: sale.tradePlatform.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sale.tradePlatform.list` retrieves a list of order sources.", "operationId": "sale_tradePlatform_list", "tags": [ "E-Commerce" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sale/trade-platform/sale-trade-platform-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_trade_platform object) ||" }, "filter": { "type": "object", "description": "| A list of fields for filtering. When specifying multiple fields, AND logic is applied." }, "order": { "type": "object", "description": "| Sorting parameters. Format: `{field: direction (ASC, DESC)}`." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select (see fields of the sale_order_trade_platform object) ||" }, "filter": { "type": "object", "description": "| A list of fields for filtering. When specifying multiple fields, AND logic is applied." }, "order": { "type": "object", "description": "| Sorting parameters. Format: `{field: direction (ASC, DESC)}`." }, "start": { "type": "integer", "description": "| This parameter is used for pagination control." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sale" ] } ] } }, "/salescenter.payment.getPublicUrl": { "post": { "summary": "Generate a Link for a Specific Payment salescenter.payment.getPublicUrl", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method generates a link for a specific payment. The payment method selected will be passed to this particular payment.", "operationId": "salescenter_payment_getPublicUrl", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/payment/salescenter-payment-get-public-url.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "| Payment identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "salescenter" ] } ] } }, "/scope": { "post": { "summary": "Get a List of Available Permissions Scope", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `scope` method returns a list of permissions.", "operationId": "scope", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/scope.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "full": { "type": "boolean", "description": "| If the parameter is set to `true`, the method will return the complete list of permissions ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "full": { "type": "boolean", "description": "| If the parameter is set to `true`, the method will return the complete list of permissions ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/server.time": { "post": { "summary": "Get Current Server Time server.time", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `server.time` returns the current server time in the format `YYYY-MM-DDThh:mm:ss±hh:mm`. No parameters.", "operationId": "server_time", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/system/server-time.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Server time in the format `YYYY-MM-DDThh:mm:ss±hh:mm` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "| Server time in the format `YYYY-MM-DDThh:mm:ss±hh:mm` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/sign.b2e.company.provider.list": { "post": { "summary": "Get the List of Providers for sign.b2e.company.provider.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sign.b2e.company.provider.list` returns a list of signature providers for the selected company. The method works only in the context of application authorization [application](../../settings/app-installation/index.md).", "operationId": "sign_b2e_company_provider_list", "tags": [ "Signature" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sign/sign-b2e-company-provider-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "companyUuid": { "type": "string", "description": "| UUID of the company in HCM Link." }, "companyCrmId": { "type": "integer", "description": "| Identifier of the company in CRM, connected in the integration as \"my company\"." }, "language": { "type": "string", "description": "| Language for localizing provider names." }, "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| Parameter for managing pagination." } }, "required": [ "companyUuid", "companyCrmId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "companyUuid": { "type": "string", "description": "| UUID of the company in HCM Link." }, "companyCrmId": { "type": "integer", "description": "| Identifier of the company in CRM, connected in the integration as \"my company\"." }, "language": { "type": "string", "description": "| Language for localizing provider names." }, "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| Parameter for managing pagination." } }, "required": [ "companyUuid", "companyCrmId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.document.get": { "post": { "summary": "Get Document sign.b2e.document.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sign.b2e.document.get` returns information about the document and signing participants. The method works only in the context of application authorization [application](../../settings/app-installation/index.md).", "operationId": "sign_b2e_document_get", "tags": [ "Signature" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sign/sign-b2e-document-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uid": { "type": "string", "description": "| Unique identifier of the document ||" }, "language": { "type": "string", "description": "| Language for localizing statuses in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "uid": { "type": "string", "description": "| Unique identifier of the document ||" }, "language": { "type": "string", "description": "| Language for localizing statuses in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.document.send": { "post": { "summary": "Send Document for Signing sign.b2e.document.send", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sign.b2e.document.send` sends a document for signing on behalf of the company. This method works only in the context of application authorization [application](../../settings/app-installation/index.md).", "operationId": "sign_b2e_document_send", "tags": [ "Signature" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sign/sign-b2e-document-send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Parameters for sending the document for signing (detailed description) ||" }, "language": { "type": "string", "description": "| Language for localizing statuses in the response." }, "company": { "type": "object", "description": "| The company on behalf of which the document is sent (detailed description) ||" }, "members": { "type": "array", "items": {}, "description": "| List of signing participants. Must contain at least one participant with the role `signer` and one with the role `assignee` (detailed description) ||" }, "responsible": { "type": "object", "description": "| Responsible person for the document (detailed description) ||" }, "companyProviderUid": { "type": "string", "description": "| Identifier of the signing provider. You can get a list of available signing providers using the sign.b2e.company.provider.list method ||" }, "files": { "type": "array", "items": {}, "description": "| File of the document being signed (detailed description) ||" }, "regionDocumentType": { "type": "string", "description": "| Document type for the region (detailed description) ||" }, "externalSettings": { "type": "object", "description": "| External parameters of the document (detailed description) ||" }, "uuid": { "type": "string", "description": "| UUID of the company in HCM Link." }, "crmId": { "type": "integer", "description": "| Identifier of the company in CRM, connected in the integration as \"my company\" ||" }, "employeeCode": { "type": "string", "description": "| Employee code in HCM Link." }, "employeeId": { "type": "integer", "description": "| Employee identifier in HCM Link." }, "userId": { "type": "integer", "description": "| User identifier in Bitrix24 ||" }, "role": { "type": "string", "description": "| Role of the participant. Possible values:" }, "fileName": { "type": "string", "description": "| File name. Must include the `.pdf` extension ||" }, "fileType": { "type": "string", "description": "| MIME type of the file. Supported `application/pdf` ||" }, "fileContent": { "type": "string", "description": "| Content of the file, encoded in Base64 ||" }, "externalId": { "type": "string", "description": "| External identifier. Maximum length — 255 characters ||" }, "externalDateCreate": { "type": "string", "description": "| Creation date of the external document in ISO 8601 format ||" } }, "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": "| Parameters for sending the document for signing (detailed description) ||" }, "language": { "type": "string", "description": "| Language for localizing statuses in the response." }, "company": { "type": "object", "description": "| The company on behalf of which the document is sent (detailed description) ||" }, "members": { "type": "array", "items": {}, "description": "| List of signing participants. Must contain at least one participant with the role `signer` and one with the role `assignee` (detailed description) ||" }, "responsible": { "type": "object", "description": "| Responsible person for the document (detailed description) ||" }, "companyProviderUid": { "type": "string", "description": "| Identifier of the signing provider. You can get a list of available signing providers using the sign.b2e.company.provider.list method ||" }, "files": { "type": "array", "items": {}, "description": "| File of the document being signed (detailed description) ||" }, "regionDocumentType": { "type": "string", "description": "| Document type for the region (detailed description) ||" }, "externalSettings": { "type": "object", "description": "| External parameters of the document (detailed description) ||" }, "uuid": { "type": "string", "description": "| UUID of the company in HCM Link." }, "crmId": { "type": "integer", "description": "| Identifier of the company in CRM, connected in the integration as \"my company\" ||" }, "employeeCode": { "type": "string", "description": "| Employee code in HCM Link." }, "employeeId": { "type": "integer", "description": "| Employee identifier in HCM Link." }, "userId": { "type": "integer", "description": "| User identifier in Bitrix24 ||" }, "role": { "type": "string", "description": "| Role of the participant. Possible values:" }, "fileName": { "type": "string", "description": "| File name. Must include the `.pdf` extension ||" }, "fileType": { "type": "string", "description": "| MIME type of the file. Supported `application/pdf` ||" }, "fileContent": { "type": "string", "description": "| Content of the file, encoded in Base64 ||" }, "externalId": { "type": "string", "description": "| External identifier. Maximum length — 255 characters ||" }, "externalDateCreate": { "type": "string", "description": "| Creation date of the external document in ISO 8601 format ||" } }, "required": [ "fields", "company", "members", "responsible", "companyProviderUid", "files", "regionDocumentType", "externalSettings", "uuid", "crmId", "employeeCode", "employeeId", "userId", "role", "fileName", "fileType", "fileContent", "externalId", "externalDateCreate" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.mysafe.tail": { "post": { "summary": "Get a list of signed documents in the company's safe sign.b2e.mysafe.tail", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sign.b2e.mysafe.tail` returns a list of signed documents in the company's safe. The method works only in the context of [application](../../settings/app-installation/index.md) authorization.", "operationId": "sign_b2e_mysafe_tail", "tags": [ "Signature" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sign/sign-b2e-mysafe-tail.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| This parameter is used to manage pagination. It is similar to the standard start parameter." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| This parameter is used to manage pagination. It is similar to the standard start parameter." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/sign.b2e.personal.tail": { "post": { "summary": "Get a list of signed documents for the user sign.b2e.personal.tail", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sign.b2e.personal.tail` returns a list of signed documents for the user from the e-Signature for HR section. The method works only in the context of authorization of the [application](../../settings/app-installation/index.md).", "operationId": "sign_b2e_personal_tail", "tags": [ "Signature" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sign/sign-b2e-personal-tail.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| This parameter is used for pagination control. It is similar to the standard parameter start." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "| Number of records per page." }, "offset": { "type": "integer", "description": "| This parameter is used for pagination control. It is similar to the standard parameter start." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sign.b2e" ] } ] } }, "/socialnetwork.api.workgroup.get": { "post": { "summary": "Retrieve Data on Workgroup socialnetwork.api.workgroup.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `socialnetwork.api.workgroup.get` returns information about a workgroup, project, scrum, or collaboration based on the identifier. An administrator can retrieve information about any group on the account, even if it is secret and they are not a member.", "operationId": "socialnetwork_api_workgroup_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/socialnetwork-api-workgroup-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Request parameters for retrieving the group. More details below ||" }, "groupId": { "type": "integer", "description": "| Group identifier. The value for this field can be obtained using the method sonet_group.get ||" }, "select": { "type": "array", "items": {}, "description": "| List of additional fields to retrieve, returned in `result`. More details below ||" }, "mode": { "type": "string", "description": "| Request mode. Can only take the value `mobile`, which allows retrieving additional data in the array `result[ADDITIONAL_DATA]` ||" }, "ACTIONS": { "type": "string", "description": "| Operations available to the current user on the group ||" }, "AVATAR": { "type": "string", "description": "| URL of the group's compressed user avatar ||" }, "AVATAR_DATA": { "type": "string", "description": "| Information about the group's avatar ||" }, "AVATAR_TYPES": { "type": "string", "description": "| Types of avatars for groups ||" }, "COUNTERS": { "type": "string", "description": "| Number of unaccepted requests and invitations to join the group ||" }, "DATE_CREATE": { "type": "string", "description": "| Date and time of group creation in a more readable format ||" }, "DEPARTMENTS": { "type": "string", "description": "| Departments of employees added to the group ||" }, "EFFICIENCY": { "type": "string", "description": "| Group efficiency ||" }, "FEATURES": { "type": "string", "description": "| Available tools in the group specified in the advanced group settings ||" }, "GROUP_MEMBERS_LIST": { "type": "string", "description": "| List of active group members, invited users, and users awaiting confirmation to join the group ||" }, "LIST_OF_MEMBERS": { "type": "string", "description": "| List of group members with their information ||" }, "LIST_OF_MEMBERS_AWAITING_INVITE": { "type": "string", "description": "| Users awaiting confirmation to join the group ||" }, "OWNER_DATA": { "type": "string", "description": "| Data about the group owner ||" }, "PIN": { "type": "string", "description": "| Whether the group is pinned for the current user on the groups and projects page. Returned as `result[IS_PIN]` ||" }, "PRIVACY_TYPE": { "type": "string", "description": "| Group privacy level. Returned as `result[PRIVACY_CODE]` ||" }, "SUBJECT_DATA": { "type": "string", "description": "| Information about the group's subject specified in the advanced group settings ||" }, "TAGS": { "type": "string", "description": "| Group tags specified in the advanced group settings ||" }, "USER_DATA": { "type": "string", "description": "| Data about the current user's role in the group ||" } }, "required": [ "params", "groupId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "params": { "type": "object", "description": "| Request parameters for retrieving the group. More details below ||" }, "groupId": { "type": "integer", "description": "| Group identifier. The value for this field can be obtained using the method sonet_group.get ||" }, "select": { "type": "array", "items": {}, "description": "| List of additional fields to retrieve, returned in `result`. More details below ||" }, "mode": { "type": "string", "description": "| Request mode. Can only take the value `mobile`, which allows retrieving additional data in the array `result[ADDITIONAL_DATA]` ||" }, "ACTIONS": { "type": "string", "description": "| Operations available to the current user on the group ||" }, "AVATAR": { "type": "string", "description": "| URL of the group's compressed user avatar ||" }, "AVATAR_DATA": { "type": "string", "description": "| Information about the group's avatar ||" }, "AVATAR_TYPES": { "type": "string", "description": "| Types of avatars for groups ||" }, "COUNTERS": { "type": "string", "description": "| Number of unaccepted requests and invitations to join the group ||" }, "DATE_CREATE": { "type": "string", "description": "| Date and time of group creation in a more readable format ||" }, "DEPARTMENTS": { "type": "string", "description": "| Departments of employees added to the group ||" }, "EFFICIENCY": { "type": "string", "description": "| Group efficiency ||" }, "FEATURES": { "type": "string", "description": "| Available tools in the group specified in the advanced group settings ||" }, "GROUP_MEMBERS_LIST": { "type": "string", "description": "| List of active group members, invited users, and users awaiting confirmation to join the group ||" }, "LIST_OF_MEMBERS": { "type": "string", "description": "| List of group members with their information ||" }, "LIST_OF_MEMBERS_AWAITING_INVITE": { "type": "string", "description": "| Users awaiting confirmation to join the group ||" }, "OWNER_DATA": { "type": "string", "description": "| Data about the group owner ||" }, "PIN": { "type": "string", "description": "| Whether the group is pinned for the current user on the groups and projects page. Returned as `result[IS_PIN]` ||" }, "PRIVACY_TYPE": { "type": "string", "description": "| Group privacy level. Returned as `result[PRIVACY_CODE]` ||" }, "SUBJECT_DATA": { "type": "string", "description": "| Information about the group's subject specified in the advanced group settings ||" }, "TAGS": { "type": "string", "description": "| Group tags specified in the advanced group settings ||" }, "USER_DATA": { "type": "string", "description": "| Data about the current user's role in the group ||" } }, "required": [ "params", "groupId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "socialnetwork" ] } ] } }, "/socialnetwork.api.workgroup.list": { "post": { "summary": "Get a List of Workgroups socialnetwork.api.workgroup.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `socialnetwork.api.workgroup.list` returns a list of workgroups, projects, scrums, and collaborations based on the current user's permissions.", "operationId": "socialnetwork_api_workgroup_list", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/socialnetwork-api-workgroup-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| An object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "order": { "type": "object", "description": "| A sorting object in the format `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "params": { "type": "object", "description": "| Additional request parameters ||" }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Group identifier ||" }, "NAME": { "type": "string", "description": "| Group name ||" }, "OWNER_ID": { "type": "integer", "description": "| Owner identifier ||" }, "ACTIVE": { "type": "string", "description": "| Group activity status: `Y` or `N` ||" }, "VISIBLE": { "type": "string", "description": "| Group visibility in the general list: `Y` or `N` ||" }, "OPENED": { "type": "string", "description": "| Is the group open for free membership: `Y` or `N` ||" }, "CLOSED": { "type": "string", "description": "| Is the group archived: `Y` or `N` ||" }, "PROJECT": { "type": "string", "description": "| Object type: `Y` — project, `N` — group ||" }, "SUBJECT_ID": { "type": "integer", "description": "| Group subject identifier ||" }, "SITE_ID": { "type": "string", "description": "| Group site identifier ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Group creation date ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Group modification date ||" }, "DATE_ACTIVITY": { "type": "string", "format": "date-time", "description": "| Last activity date ||" }, "DESCRIPTION": { "type": "string", "description": "| Group description ||" }, "KEYWORDS": { "type": "string", "description": "| Group keywords ||" }, "LANDING": { "type": "string", "description": "| Group for publication status ||" }, "IMAGE_ID": { "type": "integer", "description": "| User avatar identifier ||" }, "AVATAR_TYPE": { "type": "string", "description": "| System avatar type ||" }, "NUMBER_OF_MEMBERS": { "type": "integer", "description": "| Number of participants ||" }, "NUMBER_OF_MODERATORS": { "type": "integer", "description": "| Number of moderators ||" }, "INITIATE_PERMS": { "type": "string", "description": "| Permissions to invite participants ||" }, "PROJECT_DATE_START": { "type": "string", "format": "date-time", "description": "| Project start date ||" }, "PROJECT_DATE_FINISH": { "type": "string", "format": "date-time", "description": "| Project end date ||" }, "SCRUM_OWNER_ID": { "type": "integer", "description": "| Scrum owner identifier ||" }, "SCRUM_MASTER_ID": { "type": "integer", "description": "| Scrum master identifier ||" }, "SCRUM_SPRINT_DURATION": { "type": "integer", "description": "| Sprint duration in seconds ||" }, "SCRUM_TASK_RESPONSIBLE": { "type": "string", "description": "| Default executor in scrum ||" }, "TYPE": { "type": "string", "description": "| Group type: `group`, `project`, `scrum`, `collab` ||" }, "AVATAR": { "type": "string", "description": "| Avatar URL ||" }, "IS_ADMIN": { "type": "string", "description": "| Disable permission check." }, "siteId": { "type": "string", "description": "| Identifier of the site to be used in the automatic filter `SITE_ID` for regular users." }, "mode": { "type": "string", "description": "| Response mode." }, "features": { "type": "array", "items": {}, "description": "| List of group tool codes to consider when forming `additionalData` in `mobile` mode ||" }, "mandatoryFeatures": { "type": "array", "items": {}, "description": "| List of tool codes that should always be included in `additionalData` in `mobile` mode ||" }, "shouldSelectDialogId": { "type": "string", "description": "| Whether to add a field with the chat identifier `dialogId` to the list item." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "| An object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "select": { "type": "array", "items": {}, "description": "| An array containing the list of fields to select." }, "order": { "type": "object", "description": "| A sorting object in the format `{\"field_1\": \"order_1\", ..., \"field_N\": \"order_N\"}`." }, "params": { "type": "object", "description": "| Additional request parameters ||" }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Group identifier ||" }, "NAME": { "type": "string", "description": "| Group name ||" }, "OWNER_ID": { "type": "integer", "description": "| Owner identifier ||" }, "ACTIVE": { "type": "string", "description": "| Group activity status: `Y` or `N` ||" }, "VISIBLE": { "type": "string", "description": "| Group visibility in the general list: `Y` or `N` ||" }, "OPENED": { "type": "string", "description": "| Is the group open for free membership: `Y` or `N` ||" }, "CLOSED": { "type": "string", "description": "| Is the group archived: `Y` or `N` ||" }, "PROJECT": { "type": "string", "description": "| Object type: `Y` — project, `N` — group ||" }, "SUBJECT_ID": { "type": "integer", "description": "| Group subject identifier ||" }, "SITE_ID": { "type": "string", "description": "| Group site identifier ||" }, "DATE_CREATE": { "type": "string", "format": "date-time", "description": "| Group creation date ||" }, "DATE_UPDATE": { "type": "string", "format": "date-time", "description": "| Group modification date ||" }, "DATE_ACTIVITY": { "type": "string", "format": "date-time", "description": "| Last activity date ||" }, "DESCRIPTION": { "type": "string", "description": "| Group description ||" }, "KEYWORDS": { "type": "string", "description": "| Group keywords ||" }, "LANDING": { "type": "string", "description": "| Group for publication status ||" }, "IMAGE_ID": { "type": "integer", "description": "| User avatar identifier ||" }, "AVATAR_TYPE": { "type": "string", "description": "| System avatar type ||" }, "NUMBER_OF_MEMBERS": { "type": "integer", "description": "| Number of participants ||" }, "NUMBER_OF_MODERATORS": { "type": "integer", "description": "| Number of moderators ||" }, "INITIATE_PERMS": { "type": "string", "description": "| Permissions to invite participants ||" }, "PROJECT_DATE_START": { "type": "string", "format": "date-time", "description": "| Project start date ||" }, "PROJECT_DATE_FINISH": { "type": "string", "format": "date-time", "description": "| Project end date ||" }, "SCRUM_OWNER_ID": { "type": "integer", "description": "| Scrum owner identifier ||" }, "SCRUM_MASTER_ID": { "type": "integer", "description": "| Scrum master identifier ||" }, "SCRUM_SPRINT_DURATION": { "type": "integer", "description": "| Sprint duration in seconds ||" }, "SCRUM_TASK_RESPONSIBLE": { "type": "string", "description": "| Default executor in scrum ||" }, "TYPE": { "type": "string", "description": "| Group type: `group`, `project`, `scrum`, `collab` ||" }, "AVATAR": { "type": "string", "description": "| Avatar URL ||" }, "IS_ADMIN": { "type": "string", "description": "| Disable permission check." }, "siteId": { "type": "string", "description": "| Identifier of the site to be used in the automatic filter `SITE_ID` for regular users." }, "mode": { "type": "string", "description": "| Response mode." }, "features": { "type": "array", "items": {}, "description": "| List of group tool codes to consider when forming `additionalData` in `mobile` mode ||" }, "mandatoryFeatures": { "type": "array", "items": {}, "description": "| List of tool codes that should always be included in `additionalData` in `mobile` mode ||" }, "shouldSelectDialogId": { "type": "string", "description": "| Whether to add a field with the chat identifier `dialogId` to the list item." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "socialnetwork" ] } ] } }, "/task.checklistitem.add": { "post": { "summary": "Add checklist item task.checklistitem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.add` adds a new checklist item to a task. You can check permissions for adding an item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).", "operationId": "task_checklistitem_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "FIELDS": { "type": "object", "description": "| Object with checklist item fields ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with participant type parameter `TYPE`. Possible participant type values:" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists." } }, "required": [ "TASKID", "FIELDS", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "FIELDS": { "type": "object", "description": "| Object with checklist item fields ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with participant type parameter `TYPE`. Possible participant type values:" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists." } }, "required": [ "TASKID", "FIELDS", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.complete": { "post": { "summary": "Mark checklist item as completed task.checklistitem.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.complete` marks a checklist item as completed.", "operationId": "task_checklistitem_complete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.delete": { "post": { "summary": "Delete checklist item task.checklistitem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.delete` removes a checklist item from a task. You can check permissions for deleting an item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).", "operationId": "task_checklistitem_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.get": { "post": { "summary": "Get checklist item task.checklistitem.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.get` retrieves the description of a checklist item by its identifier.", "operationId": "task_checklistitem_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.getlist": { "post": { "summary": "Get the list of checklist items task.checklistitem.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.getlist` retrieves a list of checklist items in a task.", "operationId": "task_checklistitem_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| An object for sorting the result in the form `{\"field\": \"sort value\", ... }`." } }, "required": [ "TASKID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| An object for sorting the result in the form `{\"field\": \"sort value\", ... }`." } }, "required": [ "TASKID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.getmanifest": { "post": { "summary": "Get a list of methods and their description task.checklistitem.getmanifest", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.getmanifest` retrieves information about the methods for working with task checklist items `task.checklistitem.*`. It is recommended to use the result only as a reference, as the structure of the method's response can be changed by the developer at any time.", "operationId": "task_checklistitem_getmanifest", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get-manifest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.isactionallowed": { "post": { "summary": "Check Action Permission for task.checklistitem.isactionallowed", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.isactionallowed` checks whether an action is permitted for a checklist item in a task.", "operationId": "task_checklistitem_isactionallowed", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-is-action-allowed.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." }, "ACTIONID": { "type": "integer", "description": "| Identifier of the action being checked:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." }, "ACTIONID": { "type": "integer", "description": "| Identifier of the action being checked:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.moveafteritem": { "post": { "summary": "Move Checklist Item task.checklistitem.moveafteritem", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.moveafteritem` moves the checklist item `itemId` to a position after the element `afterItemId`. Both elements must belong to the same task `taskId`. The elements can be in different sublists, but after the move, `itemId` will have the same `PARENT_ID` as `afterItemId`. You can check permissions to modify the item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).", "operationId": "task_checklistitem_moveafteritem", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-move-after-item.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Identifier of the task." }, "ITEMID": { "type": "integer", "description": "| Identifier of the checklist item being moved." }, "AFTERITEMID": { "type": "integer", "description": "| Identifier of the checklist item after which the moving item should be placed." } }, "required": [ "TASKID", "ITEMID", "AFTERITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Identifier of the task." }, "ITEMID": { "type": "integer", "description": "| Identifier of the checklist item being moved." }, "AFTERITEMID": { "type": "integer", "description": "| Identifier of the checklist item after which the moving item should be placed." } }, "required": [ "TASKID", "ITEMID", "AFTERITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.renew": { "post": { "summary": "Mark a checklist item as incomplete task.checklistitem.renew", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.renew` marks a completed checklist item as active.", "operationId": "task_checklistitem_renew", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-renew.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.checklistitem.update": { "post": { "summary": "Update checklist item task.checklistitem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.update` modifies an existing checklist item. You can check permissions to modify the item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).", "operationId": "task_checklistitem_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." }, "FIELDS": { "type": "object", "description": "| Object with checklist item fields ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists." } }, "required": [ "TASKID", "ITEMID", "FIELDS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Checklist item identifier." }, "FIELDS": { "type": "object", "description": "| Object with checklist item fields ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists." } }, "required": [ "TASKID", "ITEMID", "FIELDS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.comment.add": { "post": { "summary": "Add Comment to Task task.comment.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [tasks.task.chat.message.send](../../rest-v3/tasks/tasks-task-chat-message-send.md). This method adds comments to a task.", "operationId": "task_comment_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-comment-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "COMMENTTEXT": { "type": "string", "description": "| Comment ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "COMMENTTEXT": { "type": "string", "description": "| Comment ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.add": { "post": { "summary": "Add Comment task.commentitem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.add` adds a new comment to a task. The development of this method has been halted since version `tasks 25.700.0`. Please use [tasks.task.chat.message.send](../../rest-v3/tasks/tasks-task-chat-message-send.md).", "operationId": "task_commentitem_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "FIELDS": { "type": "object", "description": "| Object with comment fields ||" }, "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "AUTHOR_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the comment should be created." }, "POST_DATE": { "type": "string", "description": "| Message date ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "FIELDS", "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "FIELDS": { "type": "object", "description": "| Object with comment fields ||" }, "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "AUTHOR_ID": { "type": "integer", "description": "| Identifier of the user on behalf of whom the comment should be created." }, "POST_DATE": { "type": "string", "description": "| Message date ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "FIELDS", "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.delete": { "post": { "summary": "Delete Comment task.commentitem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.delete` removes a comment. Development of this method has been halted since version `tasks 25.700.0`. The method `task.commentitem.delete` does not work in the [new task card](../tasks-new.md); please use the method [im.message.delete](../../chats/messages/im-message-delete.md) for managing task chat.", "operationId": "task_commentitem_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.get": { "post": { "summary": "Get Comment by Identifier task.commentitem.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.get` retrieves a comment by its identifier. Development of this method has been halted since version `tasks 25.700.0`. The method task.commentitem.get does not work in the [new task card](../tasks-new.md); use the method [im.dialog.messages.get](../../chats/messages/im-dialog-messages-get.md) for working with task chat.", "operationId": "task_commentitem_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.getlist": { "post": { "summary": "Get List of Comments task.commentitem.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.getlist` retrieves a list of comments for a task. The development of this method has been halted since version `tasks 25.700.0`. The method task.commentitem.getlist does not work in the [new task card](../tasks-new.md); use the method [im.dialog.messages.get](../../chats/messages/im-dialog-messages-get.md) for working with task chat.", "operationId": "task_commentitem_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| An object for sorting the result in the format `{\"field\": \"sort value\", ... }`." }, "FILTER": { "type": "object", "description": "| An object for filtering the result in the format `{\"field\": \"filter value\", ... }`. The value of the filtered field can be a single value or an array of values." } }, "required": [ "TASKID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| An object for sorting the result in the format `{\"field\": \"sort value\", ... }`." }, "FILTER": { "type": "object", "description": "| An object for filtering the result in the format `{\"field\": \"filter value\", ... }`. The value of the filtered field can be a single value or an array of values." } }, "required": [ "TASKID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.getmanifest": { "post": { "summary": "Get the list of methods and their description task.commentitem.getmanifest", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.getmanifest` retrieves up-to-date information about methods for working with task comments `task.commentitem.*`. It is recommended to use it only as a reference, as the response structure of the method can be changed by the developer at any time.", "operationId": "task_commentitem_getmanifest", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-get-manifest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.isactionallowed": { "post": { "summary": "Check if action is allowed for comment task.commentitem.isactionallowed", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.isactionallowed` checks if an action is allowed for a comment.", "operationId": "task_commentitem_isactionallowed", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-is-action-allowed.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." }, "ACTIONID": { "type": "integer", "description": "| Identifier of the action being checked:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." }, "ACTIONID": { "type": "integer", "description": "| Identifier of the action being checked:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.commentitem.update": { "post": { "summary": "Update Comment task.commentitem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.update` updates a comment. The development of this method has been halted since version `tasks 25.700.0`. The method `task.commentitem.update` does not work in the [new task card](../tasks-new.md); use the method [im.message.update](../../chats/messages/im-message-update.md) for working with task chat.", "operationId": "task_commentitem_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." }, "FIELDS": { "type": "object", "description": "| Object with comment fields ||" }, "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "ITEMID", "FIELDS", "POST_MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Comment identifier." }, "FIELDS": { "type": "object", "description": "| Object with comment fields ||" }, "POST_MESSAGE": { "type": "string", "description": "| Message text ||" }, "UF_FORUM_MESSAGE_DOC": { "type": "array", "items": {}, "description": "| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `['n123', 'n456', ... ]`." } }, "required": [ "TASKID", "ITEMID", "FIELDS", "POST_MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.dependence.add": { "post": { "summary": "Create a link between tasks task.dependence.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a dependency of one task on another.", "operationId": "task_dependence_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/task-dependence-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| The identifier of the task from which the dependency is created ||" }, "taskIdTo": { "type": "integer", "description": "| The identifier of the task for which the dependency is created ||" }, "linkType": { "type": "integer", "description": "| Type of dependency:" } }, "required": [ "taskIdFrom", "taskIdTo", "linkType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| The identifier of the task from which the dependency is created ||" }, "taskIdTo": { "type": "integer", "description": "| The identifier of the task for which the dependency is created ||" }, "linkType": { "type": "integer", "description": "| Type of dependency:" } }, "required": [ "taskIdFrom", "taskIdTo", "linkType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.dependence.delete": { "post": { "summary": "Delete the link between tasks task.dependence.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes the dependency of one task on another.", "operationId": "task_dependence_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/task-dependence-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| The identifier of the task from which the dependency is removed. The task identifier is returned by the method for creating a new task ||" }, "taskIdTo": { "type": "integer", "description": "| The identifier of the task for which the dependency is removed ||" } }, "required": [ "taskIdFrom", "taskIdTo" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskIdFrom": { "type": "integer", "description": "| The identifier of the task from which the dependency is removed. The task identifier is returned by the method for creating a new task ||" }, "taskIdTo": { "type": "integer", "description": "| The identifier of the task for which the dependency is removed ||" } }, "required": [ "taskIdFrom", "taskIdTo" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.add": { "post": { "summary": "Add Time Entry task.elapseditem.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds the elapsed time to a task. It returns the identifier of the added entry. You can check the permission to add using the special method [task.elapseditem.isactionallowed](./task-elapsed-item-is-action-allowed.md)", "operationId": "task_elapseditem_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ARFIELDS": { "type": "object", "description": "| An object containing records about the user, time, and comments (detailed description provided below) in the following structure:" }, "SECONDS": { "type": "integer", "description": "| Amount of time spent in seconds ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Comment text ||" }, "USER_ID": { "type": "integer", "description": "| User identifier ||" } }, "required": [ "TASKID", "ARFIELDS", "SECONDS", "COMMENT_TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ARFIELDS": { "type": "object", "description": "| An object containing records about the user, time, and comments (detailed description provided below) in the following structure:" }, "SECONDS": { "type": "integer", "description": "| Amount of time spent in seconds ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Comment text ||" }, "USER_ID": { "type": "integer", "description": "| User identifier ||" } }, "required": [ "TASKID", "ARFIELDS", "SECONDS", "COMMENT_TEXT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.delete": { "post": { "summary": "Delete Time Entry task.elapseditem.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a time entry. You can check the permission to delete using the special method [task.elapseditem.isactionallowed](./task-elapsed-item-is-action-allowed.md)", "operationId": "task_elapseditem_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Time entry identifier." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Time entry identifier." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.get": { "post": { "summary": "Get elapsed time record by identifier task.elapseditem.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a record of elapsed time by its identifier.", "operationId": "task_elapseditem_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Identifier of the task." }, "ITEMID": { "type": "integer", "description": "| Identifier of the elapsed time record." } }, "required": [ "TASKID", "ITEMID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Identifier of the task." }, "ITEMID": { "type": "integer", "description": "| Identifier of the elapsed time record." } }, "required": [ "TASKID", "ITEMID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.getlist": { "post": { "summary": "Get a list of time spent records task.elapseditem.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of time spent records for a task.", "operationId": "task_elapseditem_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| Object for sorting the result (detailed description provided below) ||" }, "FILTER": { "type": "object", "description": "| Object for filtering the result (detailed description provided below) ||" }, "SELECT": { "type": "array", "items": {}, "description": "| Array of fields of records that will be returned by the method. You can specify only the fields that are necessary. If the array contains the value `\"*\"`, all available fields will be returned." }, "PARAMS": { "type": "object", "description": "| Object for call options. The element is an object `NAV_PARAMS` of the form `{'call option': 'value' [, ...]}` (detailed description provided below) in the structure ||" }, "ID": { "type": "string", "description": "| Identifier of the time spent record. Can take values:" }, "USER_ID": { "type": "string", "description": "| Identifier of the user on behalf of whom the time spent record was made. Can take values:" }, "MINUTES": { "type": "string", "description": "| Time spent, in minutes. Can take values:" }, "SECONDS": { "type": "string", "description": "| Time spent, in seconds. Can take values:" }, "CREATED_DATE": { "type": "string", "description": "| Record creation date. Can take values:" }, "DATE_START": { "type": "string", "description": "| Start date. Can take values:" }, "DATE_STOP": { "type": "string", "description": "| End date. Can take values:" }, "nPageSize": { "type": "integer", "description": "| Number of items per page. To limit the load on pagination, a limit of 50 records is imposed ||" }, "iNumPage": { "type": "integer", "description": "| Page number in pagination ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ORDER": { "type": "object", "description": "| Object for sorting the result (detailed description provided below) ||" }, "FILTER": { "type": "object", "description": "| Object for filtering the result (detailed description provided below) ||" }, "SELECT": { "type": "array", "items": {}, "description": "| Array of fields of records that will be returned by the method. You can specify only the fields that are necessary. If the array contains the value `\"*\"`, all available fields will be returned." }, "PARAMS": { "type": "object", "description": "| Object for call options. The element is an object `NAV_PARAMS` of the form `{'call option': 'value' [, ...]}` (detailed description provided below) in the structure ||" }, "ID": { "type": "string", "description": "| Identifier of the time spent record. Can take values:" }, "USER_ID": { "type": "string", "description": "| Identifier of the user on behalf of whom the time spent record was made. Can take values:" }, "MINUTES": { "type": "string", "description": "| Time spent, in minutes. Can take values:" }, "SECONDS": { "type": "string", "description": "| Time spent, in seconds. Can take values:" }, "CREATED_DATE": { "type": "string", "description": "| Record creation date. Can take values:" }, "DATE_START": { "type": "string", "description": "| Start date. Can take values:" }, "DATE_STOP": { "type": "string", "description": "| End date. Can take values:" }, "nPageSize": { "type": "integer", "description": "| Number of items per page. To limit the load on pagination, a limit of 50 records is imposed ||" }, "iNumPage": { "type": "integer", "description": "| Page number in pagination ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.getmanifest": { "post": { "summary": "Get a list of methods and their descriptions task.elapseditem.getmanifest", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns a list of methods in the form of `task.elapseditem.*` and their descriptions. The return value of this method is not intended for automated processing, as its format may change without notice. The method can be useful as reference information, as it always contains up-to-date information.", "operationId": "task_elapseditem_getmanifest", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-get-manifest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Description of methods `task.elapseditem.*` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Description of methods `task.elapseditem.*` ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.isactionallowed": { "post": { "summary": "Check Action Permission for task.elapseditem.isactionallowed", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method checks whether an action is allowed on a record: creation, modification, and deletion.", "operationId": "task_elapseditem_isactionallowed", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-is-action-allowed.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Identifier of the time spent record." }, "ACTIONID": { "type": "integer", "description": "| Action identifier:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Identifier of the time spent record." }, "ACTIONID": { "type": "integer", "description": "| Action identifier:" } }, "required": [ "TASKID", "ITEMID", "ACTIONID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.elapseditem.update": { "post": { "summary": "Update Time Entry task.elapseditem.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the parameters of the specified time entry. You can check the permission to modify using the special method [task.elapseditem.isactionallowed](./task-elapsed-item-is-action-allowed.md)", "operationId": "task_elapseditem_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/elapsed-item/task-elapsed-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Time entry identifier." }, "ARFIELDS": { "type": "object", "description": "| An object containing user records, time, and comments (detailed description provided below) in the following structure:" }, "SECONDS": { "type": "integer", "description": "| Amount of time spent in seconds ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Comment text ||" }, "USER_ID": { "type": "integer", "description": "| User identifier ||" } }, "required": [ "TASKID", "ITEMID", "ARFIELDS", "SECONDS", "COMMENT_TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKID": { "type": "integer", "description": "| Task identifier." }, "ITEMID": { "type": "integer", "description": "| Time entry identifier." }, "ARFIELDS": { "type": "object", "description": "| An object containing user records, time, and comments (detailed description provided below) in the following structure:" }, "SECONDS": { "type": "integer", "description": "| Amount of time spent in seconds ||" }, "COMMENT_TEXT": { "type": "string", "description": "| Comment text ||" }, "USER_ID": { "type": "integer", "description": "| User identifier ||" } }, "required": [ "TASKID", "ITEMID", "ARFIELDS", "SECONDS", "COMMENT_TEXT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.add": { "post": { "summary": "Add Task task.item.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a new task and returns the identifier of the added task. The following [fields](./index.md) are available. Development of this method has been halted. Please use [tasks.task.add](../../tasks-task-add.md).", "operationId": "task_item_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASKDATA": { "type": "array", "items": {}, "description": "| An array of data fields for the task (`TITLE`, `DESCRIPTION`, etc.) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASKDATA": { "type": "array", "items": {}, "description": "| An array of data fields for the task (`TITLE`, `DESCRIPTION`, etc.) ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.addfile": { "post": { "summary": "Upload File to Task task.item.addfile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [tasks.task.files.attach](../../tasks-task-files-attach.md). This method uploads a file to a task. Currently, file upload is implemented via `post`, with the file content passed in the `CONTENT` parameter.", "operationId": "task_item_addfile", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-add-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "NAME": { "type": "string", "description": "| File name ||" }, "CONTENT": { "type": "string", "description": "| File content in `base64` format ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "NAME": { "type": "string", "description": "| File name ||" }, "CONTENT": { "type": "string", "description": "| File content in `base64` format ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.addtofavorite": { "post": { "summary": "Add Task to Favorites task.item.addtofavorite", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. - parameter types are not specified - parameter requirements are not indicated - no response in case of an error", "operationId": "task_item_addtofavorite", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-add-to-favourite.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "PARAMS": { "type": "string", "description": "| This parameter contains the key `AFFECT_CHILDREN`. It indicates whether to add the subtasks of this task to Favorites ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "PARAMS": { "type": "string", "description": "| This parameter contains the key `AFFECT_CHILDREN`. It indicates whether to add the subtasks of this task to Favorites ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.approve": { "post": { "summary": "Change the status of a pending task to \"completed\" task.item.approve", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the status of a pending task to \"completed.\" Development of this method has been halted. Please use [tasks.task.approve](../../tasks-task-approve.md).", "operationId": "task_item_approve", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-approve.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.complete": { "post": { "summary": "Move Task to \"Completed\" Status task.item.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method moves a task to the \"completed\" or \"conditionally completed (awaiting executor control)\" status. Development of this method has been halted. Please use [tasks.task.complete](../../tasks-task-complete.md).", "operationId": "task_item_complete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.defer": { "post": { "summary": "Defer Task to \"Deferred\" Status task.item.defer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the status of a task to \"Deferred.\" To perform this operation, the task must be in the [In Progress](./task-item-start-execution.md) status. Development of this method has been halted. Please use [tasks.task.defer](../../tasks-task-defer.md).", "operationId": "task_item_defer", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-defer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.delegate": { "post": { "summary": "Delegate Task task.item.delegate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method delegates a task to a new user. The development of this method has been halted. Please use [tasks.task.delegate](../../tasks-task-delegate.md).", "operationId": "task_item_delegate", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-delegate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "USERID": { "type": "string", "description": "| Identifier of the new executor (responsible) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "USERID": { "type": "string", "description": "| Identifier of the new executor (responsible) ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.delete": { "post": { "summary": "Delete Task task.item.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a task. The development of this method has been halted. Please use [tasks.task.delete](../../tasks-task-delete.md).", "operationId": "task_item_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.deletefile": { "post": { "summary": "Delete File Attachment from Task task.item.deletefile", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [tasks.task.update](../../tasks-task-update.md). This method removes the file attachment from a task.", "operationId": "task_item_deletefile", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-delete-file.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "ATTACHMENT_ID": { "type": "string", "description": "| Identifier of the attached file ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "ATTACHMENT_ID": { "type": "string", "description": "| Identifier of the attached file ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.deletefromfavorite": { "post": { "summary": "Remove Task from Favorites task.item.deletefromfavorite", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a task from Favorites. The development of this method has been halted. Please use [tasks.task.favorite.remove](../../tasks-task-favorite-remove.md).", "operationId": "task_item_deletefromfavorite", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-delete-from-favorite.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "PARAMS": { "type": "string", "description": "| This parameter contains the key `AFFECT_CHILDREN`. It indicates whether to add the subtasks of this task to Favorites ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "auth": { "type": "string", "description": "| Authorization token ||" }, "TASK_ID": { "type": "string", "description": "| Task identifier ||" }, "PARAMS": { "type": "string", "description": "| This parameter contains the key `AFFECT_CHILDREN`. It indicates whether to add the subtasks of this task to Favorites ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.disapprove": { "post": { "summary": "Change the pending control task status to \"not completed\" task.item.disapprove", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the status of a pending control task to \"not completed.\" Development of this method has been halted. Please use [tasks.task.disapprove](../../tasks-task-disapprove.md).", "operationId": "task_item_disapprove", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-disapprove.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getallowedactions": { "post": { "summary": "Get Allowed Actions for Task: task.item.getallowedactions", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns an array of identifiers for the allowed actions on a task. The development of this method has been halted. Please use [tasks.task.getAccess](../../tasks-task-get-access.md).", "operationId": "task_item_getallowedactions", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-allowed-actions.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getallowedtaskactionsasstrings": { "post": { "summary": "Get a List of Action Names and Their Allowability task.item.getallowedtaskactionsasstrings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns an array where the keys are the names of actions (the names correspond to the constants of the PHP class `CTaskItem`), and the values indicate whether the action is allowed (`true`) or not (`false`). The development of this method has been halted. Please use [tasks.task.getAccess](../../tasks-task-get-access.md).", "operationId": "task_item_getallowedtaskactionsasstrings", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-allowed-task-actions-as-strings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdata": { "post": { "summary": "Get Data About Task task.item.getdata", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns an array of data about the task (`TITLE`, `DESCRIPTION`, and so on). The following [fields](./index.md) are available. Development of this method has been halted. Please use [tasks.task.get](../../tasks-task-get.md).", "operationId": "task_item_getdata", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-data.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdependson": { "post": { "summary": "Get a List of Previous Tasks task.item.getdependson", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns an array containing the identifiers of tasks that the specified task depends on (the `Previous Tasks` option in the task creation form). Development of this method has been halted. Please use [tasks.task.get](../../tasks-task-get.md).", "operationId": "task_item_getdependson", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-dependson.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getdescription": { "post": { "summary": "Get Task Description task.item.getdescription", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the description of a task. Development of this method has been halted. Please use [tasks.task.get](../../tasks-task-get.md).", "operationId": "task_item_getdescription", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-description.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "FORMAT": { "type": "string", "description": "| Acceptable values:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "FORMAT": { "type": "string", "description": "| Acceptable values:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getfiles": { "post": { "summary": "Get Links to Files Attached to a Task task.item.getfiles", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns an array containing links to files attached to a task. Development of this method has been halted. Please use [tasks.task.get](../../tasks-task-get.md).", "operationId": "task_item_getfiles", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-files.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.getmanifest": { "post": { "summary": "Get a List of Methods task.item.* with Their Descriptions task.item.getmanifest", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of methods in the format `task.item.*` along with their descriptions. The return value of this method is not intended for automated processing, as its format may change without notice. This method can be useful as a reference, as it always contains up-to-date information.", "operationId": "task_item_getmanifest", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-get-manifest.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.isactionallowed": { "post": { "summary": "Check if the action task.item.isactionallowed is permitted", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns `true` if the action is allowed. Otherwise, it will return `false`. The development of this method has been halted. Please use [tasks.task.getAccess](../../tasks-task-get-access.md).", "operationId": "task_item_isactionallowed", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-is-action-allowed.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "ACTIONID": { "type": "string", "description": "| Identifier of the action being checked (see the constants of the method task.item.getallowedactions) ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" }, "ACTIONID": { "type": "string", "description": "| Identifier of the action being checked (see the constants of the method task.item.getallowedactions) ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.list": { "post": { "summary": "Get Task List: task.item.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns an array of tasks, each containing an array of fields (similar to the array returned by [task.item.getdata](task-item-get-data.md)). Development of this method has been halted. Please use [tasks.task.list](../../tasks-task-list.md).", "operationId": "task_item_list", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| An array in the format `{'sorting_field': 'sorting_direction' [, ...]}` for sorting the results. The sorting field can take the following values:" }, "FILTER": { "type": "object", "description": "| An array in the format `{'filter_field': 'filter_value' [, ...]}`. The filter field can take the following values:" }, "PARAMS": { "type": "array", "items": {}, "description": "| An array for call options. An element is an array `NAV_PARAMS` in the format `{'call_option': 'value' [, ...]}`, containing the following options:" }, "SELECT": { "type": "array", "items": {}, "description": "| An array of record fields that will be returned by the method. If the array contains the value `\"*\"`, all available fields will be returned." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| An array in the format `{'sorting_field': 'sorting_direction' [, ...]}` for sorting the results. The sorting field can take the following values:" }, "FILTER": { "type": "object", "description": "| An array in the format `{'filter_field': 'filter_value' [, ...]}`. The filter field can take the following values:" }, "PARAMS": { "type": "array", "items": {}, "description": "| An array for call options. An element is an array `NAV_PARAMS` in the format `{'call_option': 'value' [, ...]}`, containing the following options:" }, "SELECT": { "type": "array", "items": {}, "description": "| An array of record fields that will be returned by the method. If the array contains the value `\"*\"`, all available fields will be returned." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.renew": { "post": { "summary": "Change Task Status to \"Not Completed\" task.item.renew", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the task status to \"Not Completed.\" It is applicable for tasks with the status [Completed](./task-item-complete.md). Development of this method has been halted. Please use [tasks.task.renew](../../tasks-task-renew.md).", "operationId": "task_item_renew", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-renew.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.startexecution": { "post": { "summary": "Move Task to \"In Progress\" Status task.item.startexecution", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the status of a task to \"In Progress\". Development of this method has been halted. Please use [tasks.task.start](../../tasks-task-start.md).", "operationId": "task_item_startexecution", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-start-execution.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.update": { "post": { "summary": "Update Task: task.item.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the data for a task. The following [fields](./index.md) are available for updating. When updating task data, business logic and permissions are taken into account. For example, a Participant cannot rename a task—an error will be generated in such cases. It is recommended to check whether the action is allowed before updating the data ([task.item.isactionallowed](./task-item-is-action-allowed.md)). The development of this method has been halted. Please use [tasks.task.update](../../tasks-task-update.md).", "operationId": "task_item_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-item-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier. ||" }, "TASKDATA": { "type": "string", "description": "| List of fields with new values. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "TASKID": { "type": "string", "description": "| Task identifier. ||" }, "TASKDATA": { "type": "string", "description": "| List of fields with new values. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.add": { "post": { "summary": "Add Custom Field task.item.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.add` creates a custom field for a task. When creating a custom field, it is mandatory to use the prefix `UF_` in the field name `FIELD_NAME`. If the prefix is not specified, the system will automatically add it to the beginning of the name.", "operationId": "task_item_userfield_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Set of parameters for the created field (detailed description) ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field." }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "XML_ID": { "type": "string", "description": "| External identifier ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Label in the edit form (detailed description) ||" }, "LABEL": { "type": "string", "description": "| Name of the custom field ||" }, "SORT": { "type": "integer", "description": "| Sorting" }, "MULTIPLE": { "type": "string", "description": "| Multiple value. Possible values:" }, "MANDATORY": { "type": "string", "description": "| Mandatory value. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional settings for the field type (detailed description) ||" }, "de": { "type": "string", "description": "| Label in German ||" }, "en": { "type": "string", "description": "| Label in English ||" } }, "required": [ "PARAMS", "USER_TYPE_ID", "FIELD_NAME" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PARAMS": { "type": "object", "description": "| Set of parameters for the created field (detailed description) ||" }, "USER_TYPE_ID": { "type": "string", "description": "| Data type of the custom field." }, "FIELD_NAME": { "type": "string", "description": "| Code of the custom field ||" }, "XML_ID": { "type": "string", "description": "| External identifier ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Label in the edit form (detailed description) ||" }, "LABEL": { "type": "string", "description": "| Name of the custom field ||" }, "SORT": { "type": "integer", "description": "| Sorting" }, "MULTIPLE": { "type": "string", "description": "| Multiple value. Possible values:" }, "MANDATORY": { "type": "string", "description": "| Mandatory value. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional settings for the field type (detailed description) ||" }, "de": { "type": "string", "description": "| Label in German ||" }, "en": { "type": "string", "description": "| Label in English ||" } }, "required": [ "PARAMS", "USER_TYPE_ID", "FIELD_NAME" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.delete": { "post": { "summary": "Delete User Field task.item.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.delete` removes a user-defined field from a task.", "operationId": "task_item_userfield_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the user-defined field." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the user-defined field." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.get": { "post": { "summary": "Get User Field of Task by ID task.item.userfield.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.get` retrieves the description of a user field of a task by its ID.", "operationId": "task_item_userfield_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the user field." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the user field." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.getfields": { "post": { "summary": "Get Custom Field Data with task.item.userfield.getfields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.getfields` retrieves a list of fields for custom task fields.", "operationId": "task_item_userfield_getfields", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.getlist": { "post": { "summary": "Get a List of Custom Fields task.item.userfield.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.getlist` retrieves a list of custom fields for tasks. The list will include three system fields for linking to other objects: - `UF_CRM_TASK` — with CRM objects", "operationId": "task_item_userfield_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Object for sorting the result in the format `{\"field\": \"sort value\", ... }`." }, "FILTER": { "type": "object", "description": "| Object for filtering the result in the format `{\"field\": \"filter value\", ... }`. The value of the filtered field can be a single value or an array of values." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| Object for sorting the result in the format `{\"field\": \"sort value\", ... }`." }, "FILTER": { "type": "object", "description": "| Object for filtering the result in the format `{\"field\": \"filter value\", ... }`. The value of the filtered field can be a single value or an array of values." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.gettypes": { "post": { "summary": "Get a List of Available Data Types for task.item.userfield.gettypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.gettypes` retrieves the available types of custom fields. Only the following types are supported for tasks: - `string` — string", "operationId": "task_item_userfield_gettypes", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-get-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.item.userfield.update": { "post": { "summary": "Update Custom Field task.item.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.item.userfield.update` updates the parameters of a task's custom field.", "operationId": "task_item_userfield_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/user-field/task-item-user-field-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the custom field." }, "DATA": { "type": "object", "description": "| Set of parameters to be updated for the field (detailed description) ||" }, "XML_ID": { "type": "string", "description": "| External identifier ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Label in the edit form (detailed description) ||" }, "LABEL": { "type": "string", "description": "| Name of the custom field ||" }, "SORT": { "type": "integer", "description": "| Sorting" }, "MULTIPLE": { "type": "string", "description": "| Multiple value. Possible values:" }, "MANDATORY": { "type": "string", "description": "| Mandatory value. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional settings for the field type (detailed description) ||" }, "en": { "type": "string", "description": "| Label in English ||" } }, "required": [ "ID", "DATA" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the custom field." }, "DATA": { "type": "object", "description": "| Set of parameters to be updated for the field (detailed description) ||" }, "XML_ID": { "type": "string", "description": "| External identifier ||" }, "EDIT_FORM_LABEL": { "type": "object", "description": "| Label in the edit form (detailed description) ||" }, "LABEL": { "type": "string", "description": "| Name of the custom field ||" }, "SORT": { "type": "integer", "description": "| Sorting" }, "MULTIPLE": { "type": "string", "description": "| Multiple value. Possible values:" }, "MANDATORY": { "type": "string", "description": "| Mandatory value. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Additional settings for the field type (detailed description) ||" }, "en": { "type": "string", "description": "| Label in English ||" } }, "required": [ "ID", "DATA" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.items.getlist": { "post": { "summary": "Get Task List: task.items.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [tasks.task.list](../tasks-task-list.md). This method returns an array of tasks, each containing an array of fields (similar to the array returned by [task.item.getdata](task-item/task-item-get-data.md)).", "operationId": "task_items_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-items-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| An array in the format `{'sorting_field': 'sorting_direction' [, ...]}` for sorting the result. The sorting field can take the following values:" }, "FILTER": { "type": "object", "description": "| An array in the format `{'filter_field': \"filter_value\" [, ...]}`. The filter field can take the following values:" }, "TASKDATA": { "type": "array", "items": {}, "description": "| Array of returned task fields ||" }, "NAV_PARAMS": { "type": "array", "items": {}, "description": "| Pagination. The option `iNumPage` is available — page number ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ORDER": { "type": "object", "description": "| An array in the format `{'sorting_field': 'sorting_direction' [, ...]}` for sorting the result. The sorting field can take the following values:" }, "FILTER": { "type": "object", "description": "| An array in the format `{'filter_field': \"filter_value\" [, ...]}`. The filter field can take the following values:" }, "TASKDATA": { "type": "array", "items": {}, "description": "| Array of returned task fields ||" }, "NAV_PARAMS": { "type": "array", "items": {}, "description": "| Pagination. The option `iNumPage` is available — page number ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.logitem.list": { "post": { "summary": "View Task Change History task.logitem.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [tasks.task.history.list](../../tasks-task-history-list.md). This method returns the history of changes for a task.", "operationId": "task_logitem_list", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-item/task-log-item-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "ID": { "type": "string", "description": "| Task identifier ||" } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Name": { "type": "string", "description": "| Description ||" }, "ID": { "type": "string", "description": "| Task identifier ||" } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.planner.getlist": { "post": { "summary": "Get the list of tasks from the Planner for the day task.planner.getlist", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.planner.getlist` retrieves a list of task identifiers from the \"Planner for the day\" of the current user. To get detailed information about the tasks, use the method [tasks.task.get](../tasks-task-get.md).", "operationId": "task_planner_getlist", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/planner/task-planner-get-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.add": { "post": { "summary": "Add a Kanban or \"My Planner\" Stage task.stages.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method adds a Kanban or \"My Planner\" stage.", "operationId": "task_stages_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new stage ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided the requester is an account administrator ||" }, "TITLE": { "type": "string", "description": "| Stage title ||" }, "COLOR": { "type": "string", "description": "| Stage color in RGB format ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the stage after which the new stage should be added." }, "ENTITY_ID": { "type": "integer", "description": "| Object identifier." } }, "required": [ "fields", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new stage ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided the requester is an account administrator ||" }, "TITLE": { "type": "string", "description": "| Stage title ||" }, "COLOR": { "type": "string", "description": "| Stage color in RGB format ||" }, "AFTER_ID": { "type": "integer", "description": "| Identifier of the stage after which the new stage should be added." }, "ENTITY_ID": { "type": "integer", "description": "| Object identifier." } }, "required": [ "fields", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.canmovetask": { "post": { "summary": "Check the ability to move a task task.stages.canmovetask", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method checks whether the current user can move tasks in the specified object.", "operationId": "task_stages_canmovetask", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-can-move-task.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| `ID` of the object ||" }, "entityType": { "type": "string", "description": "| Type of the object:" } }, "required": [ "entityId", "entityType" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| `ID` of the object ||" }, "entityType": { "type": "string", "description": "| Type of the object:" } }, "required": [ "entityId", "entityType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.delete": { "post": { "summary": "Delete a Kanban or \"My Planner\" Stage task.stages.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a Kanban or \"My Planner\" stage. It takes the `id` of the stage as input. The stage is checked for sufficient access permission, as well as for the absence of tasks within it.", "operationId": "task_stages_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the stage to be deleted ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided the requester is an account administrator ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the stage to be deleted ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided the requester is an account administrator ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.get": { "post": { "summary": "Get the list of Kanban stages or \"My Planner\" task.stages.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves the stages of the Kanban or \"My Planner\".", "operationId": "task_stages_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the object." }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided that the requester is an administrator of the account. ||" } }, "required": [ "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "entityId": { "type": "integer", "description": "| Identifier of the object." }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided that the requester is an administrator of the account. ||" } }, "required": [ "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.movetask": { "post": { "summary": "Move a task from one stage to another task.stages.movetask", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method moves a task from one stage to another and allows changing the position of the task within the kanban of the group or \"My Planner\". The method works as follows: - If a group stage is provided, the movement occurs within the group's kanban.", "operationId": "task_stages_movetask", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-move-task.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" }, "stageId": { "type": "integer", "description": "| `ID` of the stage to which the task should be moved ||" }, "before": { "type": "integer", "description": "| `ID` of the task before which the task should be placed in the stage ||" }, "after": { "type": "integer", "description": "| `ID` of the task after which the task should be placed in the stage ||" } }, "required": [ "id", "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" }, "stageId": { "type": "integer", "description": "| `ID` of the stage to which the task should be moved ||" }, "before": { "type": "integer", "description": "| `ID` of the task before which the task should be placed in the stage ||" }, "after": { "type": "integer", "description": "| `ID` of the task after which the task should be placed in the stage ||" } }, "required": [ "id", "stageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/task.stages.update": { "post": { "summary": "Update the stage of the kanban or \"My Planner\" task.stages.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method updates the stages of the kanban or \"My Planner\". The method is also used to move a stage from one position to another. To do this, simply pass the required `AFTER_ID`.", "operationId": "task_stages_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/stages/task-stages-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the stage ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values (detailed description provided below) for updating the kanban or \"My Planner\" stage ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided that the requester is an administrator of the account ||" }, "TITLE": { "type": "string", "description": "`string` | Title of the stage ||" }, "COLOR": { "type": "string", "description": "`string` | Color of the stage in RGB format ||" }, "AFTER_ID": { "type": "string", "description": "`integer` | Identifier of the stage after which the new stage should be added." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the stage ||" }, "fields": { "type": "array", "items": {}, "description": "| Field values (detailed description provided below) for updating the kanban or \"My Planner\" stage ||" }, "isAdmin": { "type": "boolean", "description": "| If set to `true`, permission checks will not occur, provided that the requester is an administrator of the account ||" }, "TITLE": { "type": "string", "description": "`string` | Title of the stage ||" }, "COLOR": { "type": "string", "description": "`string` | Color of the stage in RGB format ||" }, "AFTER_ID": { "type": "string", "description": "`integer` | Identifier of the stage after which the new stage should be added." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.add": { "post": { "summary": "Add backlog in Scrum tasks.api.scrum.backlog.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.backlog.add` adds a backlog in Scrum. It may be necessary to create a backlog during import after creating the Scrum.", "operationId": "tasks_api_scrum_backlog_add", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing records about the group and user (detailed description provided below) in the following structure:" }, "groupId": { "type": "integer", "description": "| The identifier of the group for which the backlog is created." }, "createdBy": { "type": "integer", "description": "| The identifier of the user who will create the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| The identifier of the user who will modify the backlog ||" } }, "required": [ "fields", "groupId", "createdBy" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object containing records about the group and user (detailed description provided below) in the following structure:" }, "groupId": { "type": "integer", "description": "| The identifier of the group for which the backlog is created." }, "createdBy": { "type": "integer", "description": "| The identifier of the user who will create the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| The identifier of the user who will modify the backlog ||" } }, "required": [ "fields", "groupId", "createdBy" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.delete": { "post": { "summary": "Delete backlog tasks.api.scrum.backlog.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.backlog.delete` removes the backlog. In normal circumstances, there is no need to delete the backlog. When the backlog is deleted, *Bitrix24* will automatically recreate it when the planning page in Scrum tasks is opened. The method is used if the backlog was mistakenly added to a group or project that is not Scrum.", "operationId": "tasks_api_scrum_backlog_delete", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Backlog identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Backlog identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.get": { "post": { "summary": "Get Backlog Fields by Scrum ID tasks.api.scrum.backlog.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.backlog.get` returns the values of backlog fields by Scrum `id`. You may need to obtain the `id` of the backlog to add or move a task to the backlog.", "operationId": "tasks_api_scrum_backlog_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the group." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the group." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.getFields": { "post": { "summary": "Get a list of available backlog fields tasks.api.scrum.backlog.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.backlog.getFields` returns the available backlog fields. Without parameters.", "operationId": "tasks_api_scrum_backlog_getFields", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "| Identifier of the group for which the backlog was created ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who modified the backlog ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "| Identifier of the group for which the backlog was created ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who modified the backlog ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.backlog.update": { "post": { "summary": "Update backlog tasks.api.scrum.backlog.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates the backlog.", "operationId": "tasks_api_scrum_backlog_update", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Backlog identifier." }, "fields": { "type": "object", "description": "| An object containing records about the group and user (detailed description provided below) in the following structure:" }, "groupId": { "type": "integer", "description": "| Identifier of the group to which the backlog belongs." }, "createdBy": { "type": "integer", "description": "| Identifier of the user who will create the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who will modify the backlog ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Backlog identifier." }, "fields": { "type": "object", "description": "| An object containing records about the group and user (detailed description provided below) in the following structure:" }, "groupId": { "type": "integer", "description": "| Identifier of the group to which the backlog belongs." }, "createdBy": { "type": "integer", "description": "| Identifier of the user who will create the backlog ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who will modify the backlog ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.add": { "post": { "summary": "Add Epic in Scrum tasks.api.scrum.epic.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds an epic to Scrum.", "operationId": "tasks_api_scrum_epic_add", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new epic in the form of a structure:" }, "name": { "type": "string", "description": "| Epic name ||" }, "description": { "type": "string", "description": "| Epic description ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "| Epic color ||" }, "files": { "type": "array", "items": {}, "description": "| Array of files associated with the epic." }, "createdBy": { "type": "integer", "description": "| Created by ||" }, "modifiedBy": { "type": "integer", "description": "| Modified by ||" } }, "required": [ "fields", "name", "groupId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Field values (detailed description provided below) for adding a new epic in the form of a structure:" }, "name": { "type": "string", "description": "| Epic name ||" }, "description": { "type": "string", "description": "| Epic description ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "| Epic color ||" }, "files": { "type": "array", "items": {}, "description": "| Array of files associated with the epic." }, "createdBy": { "type": "integer", "description": "| Created by ||" }, "modifiedBy": { "type": "integer", "description": "| Modified by ||" } }, "required": [ "fields", "name", "groupId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.delete": { "post": { "summary": "Delete Epic tasks.api.scrum.epic.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an epic.", "operationId": "tasks_api_scrum_epic_delete", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the epic." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the epic." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.get": { "post": { "summary": "Get Epic Fields by Its Identifier tasks.api.scrum.epic.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. - The structure of the parameter files relates to the Drive module, so it is not described here. A link should be made when the structure description appears in the documentation. The method retrieves the values of the epic fields by its identifier `id`.", "operationId": "tasks_api_scrum_epic_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Epic identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Epic identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.getFields": { "post": { "summary": "Get a list of available fields for epic tasks.api.scrum.epic.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.epic.getFields` returns the available fields for an epic. No parameters.", "operationId": "tasks_api_scrum_epic_getFields", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "`type` | Description ||" }, "name": { "type": "string", "description": "`string` | Epic name ||" }, "description": { "type": "string", "description": "`string` | Epic description ||" }, "groupId": { "type": "string", "description": "`integer` | Identifier of the group (scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "`string` | Epic color ||" }, "files": { "type": "string", "description": "`array` | Array of files attached to the epic ||" }, "createdBy": { "type": "string", "description": "`integer` | Created by ||" }, "modifiedBy": { "type": "string", "description": "`integer` | Modified by ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Field": { "type": "string", "description": "`type` | Description ||" }, "name": { "type": "string", "description": "`string` | Epic name ||" }, "description": { "type": "string", "description": "`string` | Epic description ||" }, "groupId": { "type": "string", "description": "`integer` | Identifier of the group (scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "`string` | Epic color ||" }, "files": { "type": "string", "description": "`array` | Array of files attached to the epic ||" }, "createdBy": { "type": "string", "description": "`integer` | Created by ||" }, "modifiedBy": { "type": "string", "description": "`integer` | Modified by ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.list": { "post": { "summary": "Get a List of Epics tasks.api.scrum.epic.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns a list of epics.", "operationId": "tasks_api_scrum_epic_list", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "items": {}, "description": "| An array for sorting the result in the format `{'sort_field': 'sort_direction' [, ...]}`." }, "filter": { "type": "array", "items": {}, "description": "| An array in the format `{'filter_field': 'filter_value' [, ...]}`." }, "select": { "type": "array", "items": {}, "description": "| An array of record fields that will be returned by the method." }, "start": { "type": "integer", "description": "| The page number of the output. Works for HTTPS requests." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "array", "items": {}, "description": "| An array for sorting the result in the format `{'sort_field': 'sort_direction' [, ...]}`." }, "filter": { "type": "array", "items": {}, "description": "| An array in the format `{'filter_field': 'filter_value' [, ...]}`." }, "select": { "type": "array", "items": {}, "description": "| An array of record fields that will be returned by the method." }, "start": { "type": "integer", "description": "| The page number of the output. Works for HTTPS requests." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.epic.update": { "post": { "summary": "Update Epic in Scrum tasks.api.scrum.epic.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates an epic in Scrum.", "operationId": "tasks_api_scrum_epic_update", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/epic/tasks-api-scrum-epic-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Epic identifier." }, "fields": { "type": "array", "items": {}, "description": "| Field values (detailed description provided below) for adding a new epic in the form of a structure:" }, "name": { "type": "string", "description": "| Epic name ||" }, "description": { "type": "string", "description": "| Epic description ||" }, "groupId": { "type": "integer", "description": "| Group identifier (Scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "| Epic color ||" }, "files": { "type": "array", "items": {}, "description": "| Array of files associated with the epic." } }, "required": [ "id", "fields", "name", "groupId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Epic identifier." }, "fields": { "type": "array", "items": {}, "description": "| Field values (detailed description provided below) for adding a new epic in the form of a structure:" }, "name": { "type": "string", "description": "| Epic name ||" }, "description": { "type": "string", "description": "| Epic description ||" }, "groupId": { "type": "integer", "description": "| Group identifier (Scrum) to which the epic belongs ||" }, "color": { "type": "string", "description": "| Epic color ||" }, "files": { "type": "array", "items": {}, "description": "| Array of files associated with the epic." } }, "required": [ "id", "fields", "name", "groupId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.addStage": { "post": { "summary": "Create a Scrum Kanban Stage tasks.api.scrum.kanban.addStage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates a Scrum Kanban stage. A Scrum Kanban must include stages of type new `NEW` and final `FINISH`. Use this method only for active sprints, meaning with the field `\"status\": \"active\"`.", "operationId": "tasks_api_scrum_kanban_addStage", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-stage.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields corresponding to the available list of fields tasks.api.scrum.kanban.getFields (detailed description provided below) ||" }, "sprintId": { "type": "integer", "description": "| Sprint identifier. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "name": { "type": "string", "description": "| Name of the Kanban stage ||" }, "type": { "type": "string", "description": "| Type of the Kanban stage. Possible values: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Sort order. The field value must be a multiple of `100` ||" }, "color": { "type": "string", "description": "| Color of the Kanban stage ||" } }, "required": [ "fields", "sprintId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields corresponding to the available list of fields tasks.api.scrum.kanban.getFields (detailed description provided below) ||" }, "sprintId": { "type": "integer", "description": "| Sprint identifier. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "name": { "type": "string", "description": "| Name of the Kanban stage ||" }, "type": { "type": "string", "description": "| Type of the Kanban stage. Possible values: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Sort order. The field value must be a multiple of `100` ||" }, "color": { "type": "string", "description": "| Color of the Kanban stage ||" } }, "required": [ "fields", "sprintId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.addTask": { "post": { "summary": "Add Task to Scrum Kanban tasks.api.scrum.kanban.addTask", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a task to the Scrum kanban.", "operationId": "tasks_api_scrum_kanban_addTask", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-add-task.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Identifier of the task. You can obtain the identifier using the method tasks.task.list ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" } }, "required": [ "sprintId", "taskId", "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "taskId": { "type": "integer", "description": "| Identifier of the task. You can obtain the identifier using the method tasks.task.list ||" }, "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" } }, "required": [ "sprintId", "taskId", "stageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.deleteStage": { "post": { "summary": "Delete Stage tasks.api.scrum.kanban.deleteStage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes a stage. The stage will not be deleted if it contains tasks.", "operationId": "tasks_api_scrum_kanban_deleteStage", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-stage.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" } }, "required": [ "stageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" } }, "required": [ "stageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.deleteTask": { "post": { "summary": "Delete Task from Scrum Kanban tasks.api.scrum.kanban.deleteTask", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a task from the Scrum kanban. The task will remain in the sprint on the planning page. The method will not move the task to the [backlog](../backlog/index.md).", "operationId": "tasks_api_scrum_kanban_deleteTask", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-delete-task.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Sprint identifier. You can obtain the identifier using the tasks.api.scrum.sprint.list method ||" }, "taskId": { "type": "integer", "description": "| Task identifier. You can obtain the identifier using the tasks.task.list method ||" } }, "required": [ "sprintId", "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| Sprint identifier. You can obtain the identifier using the tasks.api.scrum.sprint.list method ||" }, "taskId": { "type": "integer", "description": "| Task identifier. You can obtain the identifier using the tasks.task.list method ||" } }, "required": [ "sprintId", "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.getFields": { "post": { "summary": "Get a list of available fields for the kanban stage tasks.api.scrum.kanban.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the available fields for the kanban stage. No parameters.", "operationId": "tasks_api_scrum_kanban_getFields", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.getStages": { "post": { "summary": "Get Kanban Stages by Sprint ID tasks.api.scrum.kanban.getStages", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method returns the Kanban stages by the sprint ID.", "operationId": "tasks_api_scrum_kanban_getStages", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-get-stages.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| The identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" } }, "required": [ "sprintId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| The identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" } }, "required": [ "sprintId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.kanban.updateStage": { "post": { "summary": "Update Scrum Kanban Stage tasks.api.scrum.kanban.updateStage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the stage of the Scrum Kanban.", "operationId": "tasks_api_scrum_kanban_updateStage", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/kanban/tasks-api-scrum-kanban-update-stage.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" }, "fields": { "type": "object", "description": "| Fields corresponding to the available list of fields tasks.api.scrum.kanban.getFields (detailed description provided below) ||" }, "sprintId": { "type": "integer", "description": "| Identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "name": { "type": "string", "description": "| Name of the kanban stage ||" }, "type": { "type": "string", "description": "| Type of the kanban stage. Possible values: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Sort order. The value of the field must be a multiple of `100` ||" }, "color": { "type": "string", "description": "| Color of the kanban stage ||" } }, "required": [ "stageId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "stageId": { "type": "integer", "description": "| Identifier of the stage. You can obtain the identifier using the method tasks.api.scrum.kanban.getStages ||" }, "fields": { "type": "object", "description": "| Fields corresponding to the available list of fields tasks.api.scrum.kanban.getFields (detailed description provided below) ||" }, "sprintId": { "type": "integer", "description": "| Identifier of the sprint. You can obtain the identifier using the method tasks.api.scrum.sprint.list ||" }, "name": { "type": "string", "description": "| Name of the kanban stage ||" }, "type": { "type": "string", "description": "| Type of the kanban stage. Possible values: `NEW`, `WORK`, `FINISH` ||" }, "sort": { "type": "integer", "description": "| Sort order. The value of the field must be a multiple of `100` ||" }, "color": { "type": "string", "description": "| Color of the kanban stage ||" } }, "required": [ "stageId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.add": { "post": { "summary": "Add Sprint in Scrum tasks.api.scrum.sprint.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.add` adds a sprint to Scrum.", "operationId": "tasks_api_scrum_sprint_add", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing sprint data ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs." }, "name": { "type": "string", "description": "| Name of the sprint ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "dateStart": { "type": "string", "description": "| Start date of the sprint. Available formats: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| End date of the sprint. Available formats: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Status of the sprint. Available values: `active`, `planned`, `completed` ||" } }, "required": [ "fields", "groupId", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object containing sprint data ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs." }, "name": { "type": "string", "description": "| Name of the sprint ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "dateStart": { "type": "string", "description": "| Start date of the sprint. Available formats: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| End date of the sprint. Available formats: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Status of the sprint. Available values: `active`, `planned`, `completed` ||" } }, "required": [ "fields", "groupId", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.complete": { "post": { "summary": "Complete the active sprint of the selected Scrum tasks.api.scrum.sprint.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.complete` completes the active sprint of the selected Scrum. When the sprint is completed, unfinished tasks are moved to the backlog.", "operationId": "tasks_api_scrum_sprint_complete", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the group with the active sprint ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the group with the active sprint ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.delete": { "post": { "summary": "Delete Sprint tasks.api.scrum.sprint.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.delete` deletes a sprint. When a sprint with tasks is deleted, the tasks will be moved to the backlog.", "operationId": "tasks_api_scrum_sprint_delete", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.get": { "post": { "summary": "Get Sprint Fields by Its Identifier tasks.api.scrum.sprint.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.get` returns the values of the sprint fields by its identifier.", "operationId": "tasks_api_scrum_sprint_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| The identifier of the sprint." } }, "required": [ "sprintId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sprintId": { "type": "integer", "description": "| The identifier of the sprint." } }, "required": [ "sprintId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.getFields": { "post": { "summary": "Get a list of available fields for the sprint tasks.api.scrum.sprint.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.getFields` returns the available fields for the sprint. No parameters.", "operationId": "tasks_api_scrum_sprint_getFields", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs ||" }, "name": { "type": "string", "description": "| Name of the sprint ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the sprint ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who modified the sprint ||" }, "dateStart": { "type": "string", "description": "| Start date of the sprint in `ISO 8601` format ||" }, "dateEnd": { "type": "string", "description": "| End date of the sprint in `ISO 8601` format ||" }, "status": { "type": "string", "description": "| Status of the sprint ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs ||" }, "name": { "type": "string", "description": "| Name of the sprint ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "createdBy": { "type": "integer", "description": "| Identifier of the user who created the sprint ||" }, "modifiedBy": { "type": "integer", "description": "| Identifier of the user who modified the sprint ||" }, "dateStart": { "type": "string", "description": "| Start date of the sprint in `ISO 8601` format ||" }, "dateEnd": { "type": "string", "description": "| End date of the sprint in `ISO 8601` format ||" }, "status": { "type": "string", "description": "| Status of the sprint ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.list": { "post": { "summary": "Get the list of sprints tasks.api.scrum.sprint.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.list` returns a list of sprints. This method is similar to other methods with filtering by list.", "operationId": "tasks_api_scrum_sprint_list", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the result. The object format is `{'sorting_field': 'sorting_direction' [, ...]}`. Available fields are described in the table below." }, "filter": { "type": "object", "description": "| An object in the format `{'filter_field': 'filter_value' [, ...]}`. Available fields are described in the table below ||" }, "select": { "type": "object", "description": "| An array of record fields that will be returned by the method. You can specify only the fields that are necessary." }, "start": { "type": "integer", "description": "| The page number of the output. Works for https requests ||" }, "ID": { "type": "integer", "description": "| Sprint identifier ||" }, "GROUP_ID": { "type": "integer", "description": "| Scrum identifier ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Entity type ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Modified by ||" }, "DATE_START": { "type": "string", "description": "| Start date ||" }, "DATE_END": { "type": "string", "description": "| End date ||" }, "STATUS": { "type": "string", "description": "| Status ||" }, "INFO": { "type": "object", "description": "| Information ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the result. The object format is `{'sorting_field': 'sorting_direction' [, ...]}`. Available fields are described in the table below." }, "filter": { "type": "object", "description": "| An object in the format `{'filter_field': 'filter_value' [, ...]}`. Available fields are described in the table below ||" }, "select": { "type": "object", "description": "| An array of record fields that will be returned by the method. You can specify only the fields that are necessary." }, "start": { "type": "integer", "description": "| The page number of the output. Works for https requests ||" }, "ID": { "type": "integer", "description": "| Sprint identifier ||" }, "GROUP_ID": { "type": "integer", "description": "| Scrum identifier ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Entity type ||" }, "NAME": { "type": "string", "description": "| Name ||" }, "SORT": { "type": "integer", "description": "| Sorting ||" }, "CREATED_BY": { "type": "integer", "description": "| Created by ||" }, "MODIFIED_BY": { "type": "integer", "description": "| Modified by ||" }, "DATE_START": { "type": "string", "description": "| Start date ||" }, "DATE_END": { "type": "string", "description": "| End date ||" }, "STATUS": { "type": "string", "description": "| Status ||" }, "INFO": { "type": "object", "description": "| Information ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.start": { "post": { "summary": "Start Sprint tasks.api.scrum.sprint.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.start` initiates a sprint. Only a planned sprint can be started. When starting a sprint, the columns of the active sprint and Automation rules will be carried over from the previous completed sprint, if one exists.", "operationId": "tasks_api_scrum_sprint_start", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.sprint.update": { "post": { "summary": "Update Sprint tasks.api.scrum.sprint.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.api.scrum.sprint.update` updates a sprint.", "operationId": "tasks_api_scrum_sprint_update", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/sprint/tasks-api-scrum-sprint-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" }, "fields": { "type": "object", "description": "| Object containing sprint data ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs." }, "name": { "type": "string", "description": "| Sprint name ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "dateStart": { "type": "string", "description": "| Sprint start date. Available formats: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Sprint end date. Available formats: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Sprint status. Available values: `active`, `planned`, `completed` ||" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Sprint identifier ||" }, "fields": { "type": "object", "description": "| Object containing sprint data ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group (Scrum) to which the sprint belongs." }, "name": { "type": "string", "description": "| Sprint name ||" }, "sort": { "type": "integer", "description": "| Sorting ||" }, "dateStart": { "type": "string", "description": "| Sprint start date. Available formats: `ISO 8601`, `timestamp` ||" }, "dateEnd": { "type": "string", "description": "| Sprint end date. Available formats: `ISO 8601`, `timestamp` ||" }, "status": { "type": "string", "description": "| Sprint status. Available values: `active`, `planned`, `completed` ||" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.get": { "post": { "summary": "Get Scrum Task Fields by ID tasks.api.scrum.task.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the values of the Scrum task fields by its identifier `id`.", "operationId": "tasks_api_scrum_task_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.getFields": { "post": { "summary": "Get Scrum Task Fields tasks.api.scrum.task.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method retrieves the available fields of a Scrum task. No parameters.", "operationId": "tasks_api_scrum_task_getFields", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.api.scrum.task.update": { "post": { "summary": "Create or Update a Scrum Task tasks.api.scrum.task.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method creates or updates a Scrum task. You will be able to: - create a task in Scrum - move a task from another project", "operationId": "tasks_api_scrum_task_update", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/task/tasks-api-scrum-task-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" }, "fields": { "type": "object", "description": "| An object containing records about the Scrum task (detailed description provided below) in the following structure:" } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier ||" }, "fields": { "type": "object", "description": "| An object containing records about the Scrum task (detailed description provided below) in the following structure:" } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.activate": { "post": { "summary": "Activate/Deactivate Flow tasks.flow.Flow.activate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.activate` turns a flow on or off by its identifier. If the flow is off, it turns it on. If it is on, it turns it off.", "operationId": "tasks_flow_Flow_activate", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-activate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| The identifier of the flow to be turned on or off." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| The identifier of the flow to be turned on or off." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.create": { "post": { "summary": "Create a new Flow tasks.flow.Flow.create", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.create` creates a flow. The flow must be linked to a group. If a group ID is not provided when creating the flow, a new group will be automatically created, consisting of the creator, administrator, and the flow team.", "operationId": "tasks_flow_Flow_create", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-create.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Field values for creating the flow (detailed description is provided below) ||" }, "name": { "type": "string", "description": "| The name of the flow. Must be unique for each flow." }, "description": { "type": "string", "description": "| Description of the flow ||" }, "groupId": { "type": "integer", "description": "| The ID of the group to which the flow will be linked." }, "ownerId": { "type": "integer", "description": "| The ID of the flow administrator." }, "templateId": { "type": "integer", "description": "| The ID of the template that users will use to add tasks to the flow ||" }, "plannedCompletionTime": { "type": "integer", "description": "| The planned time to complete the task in seconds ||" }, "distributionType": { "type": "string", "description": "| Distribution type:" }, "responsibleList": { "type": "object", "description": "| IDs of employees who will receive tasks." }, "taskCreators": { "type": "object", "description": "| A list of users who can add tasks to the flow in the format `{\"\": \"\"}`. For example:" }, "matchWorkTime": { "type": "integer", "description": "| Skip weekends and holidays when calculating the task deadline." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Can the responsible person change the task deadline." }, "notifyAtHalfTime": { "type": "integer", "description": "| Notify the assignee at half the task deadline." }, "taskControl": { "type": "integer", "description": "| Send the completed task to the creator for review." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in the queue exceeds this parameter." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in progress exceeds this parameter." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Notify the flow administrator when efficiency drops below this parameter." } }, "required": [ "flowData", "name", "plannedCompletionTime", "distributionType", "responsibleList" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Field values for creating the flow (detailed description is provided below) ||" }, "name": { "type": "string", "description": "| The name of the flow. Must be unique for each flow." }, "description": { "type": "string", "description": "| Description of the flow ||" }, "groupId": { "type": "integer", "description": "| The ID of the group to which the flow will be linked." }, "ownerId": { "type": "integer", "description": "| The ID of the flow administrator." }, "templateId": { "type": "integer", "description": "| The ID of the template that users will use to add tasks to the flow ||" }, "plannedCompletionTime": { "type": "integer", "description": "| The planned time to complete the task in seconds ||" }, "distributionType": { "type": "string", "description": "| Distribution type:" }, "responsibleList": { "type": "object", "description": "| IDs of employees who will receive tasks." }, "taskCreators": { "type": "object", "description": "| A list of users who can add tasks to the flow in the format `{\"\": \"\"}`. For example:" }, "matchWorkTime": { "type": "integer", "description": "| Skip weekends and holidays when calculating the task deadline." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Can the responsible person change the task deadline." }, "notifyAtHalfTime": { "type": "integer", "description": "| Notify the assignee at half the task deadline." }, "taskControl": { "type": "integer", "description": "| Send the completed task to the creator for review." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in the queue exceeds this parameter." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in progress exceeds this parameter." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Notify the flow administrator when efficiency drops below this parameter." } }, "required": [ "flowData", "name", "plannedCompletionTime", "distributionType", "responsibleList" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.delete": { "post": { "summary": "Delete Flow tasks.flow.Flow.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.delete` removes a flow by its identifier.", "operationId": "tasks_flow_Flow_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Object containing data to delete the flow ||" }, "flowData.id": { "type": "integer", "description": "| Identifier of the flow to be deleted." } }, "required": [ "flowData", "flowData.id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Object containing data to delete the flow ||" }, "flowData.id": { "type": "integer", "description": "| Identifier of the flow to be deleted." } }, "required": [ "flowData", "flowData.id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.get": { "post": { "summary": "Get Flow tasks.flow.Flow.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.get` returns flow data by its identifier.", "operationId": "tasks_flow_Flow_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "description": "`integer` | The identifier of the flow whose data needs to be retrieved." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "description": "`integer` | The identifier of the flow whose data needs to be retrieved." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.isExists": { "post": { "summary": "Check the existence of the Flow tasks.flow.Flow.isExists", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.isExists` checks whether a flow with the specified name exists. If an `id` is provided, it checks for flows with the same name, excluding the specified one.", "operationId": "tasks_flow_Flow_isExists", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-is-exists.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Object containing data to check the existence of the flow ||" }, "name": { "type": "string", "description": "| The name of the flow to check ||" }, "id": { "type": "integer", "description": "| The identifier of the flow to exclude from the check (optional)." } }, "required": [ "flowData", "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Object containing data to check the existence of the flow ||" }, "name": { "type": "string", "description": "| The name of the flow to check ||" }, "id": { "type": "integer", "description": "| The identifier of the flow to exclude from the check (optional)." } }, "required": [ "flowData", "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.pin": { "post": { "summary": "Pin or Unpin Flow tasks.flow.Flow.pin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method pins or unpins a flow in the list of flows by its identifier.", "operationId": "tasks_flow_Flow_pin", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-pin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| The identifier of the flow to be pinned or unpinned." } }, "required": [ "flowId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "| The identifier of the flow to be pinned or unpinned." } }, "required": [ "flowId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.flow.Flow.update": { "post": { "summary": "Update Flow tasks.flow.Flow.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.flow.Flow.update` modifies the flow.", "operationId": "tasks_flow_Flow_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/flow/tasks-flow-flow-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Field values for modifying the flow (detailed description provided below) ||" }, "id": { "type": "integer", "description": "| Identifier of the flow to be modified." }, "name": { "type": "string", "description": "| Name of the flow. Must be unique for each flow." }, "description": { "type": "string", "description": "| Description of the flow ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group to which the flow will be linked." }, "ownerId": { "type": "integer", "description": "| Identifier of the flow administrator." }, "templateId": { "type": "integer", "description": "| Identifier of the template that users will use to add tasks to the flow ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Planned time to complete the task in seconds ||" }, "distributionType": { "type": "string", "description": "| Type of distribution:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Identifiers of employees who will receive tasks." }, "taskCreators": { "type": "object", "description": "| List of users who can add tasks to the flow in the format `{\"\": \"\"}`. For example:" }, "matchWorkTime": { "type": "integer", "description": "| Skip weekends and holidays when calculating the task deadline." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Can the responsible person change the task deadline?" }, "notifyAtHalfTime": { "type": "integer", "description": "| Notify the assignee at half the task deadline." }, "taskControl": { "type": "integer", "description": "| Send the completed task to the creator for review." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in the queue exceeds this parameter." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in progress exceeds this parameter." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Notify the flow administrator when efficiency drops below this parameter." } }, "required": [ "flowData", "id", "plannedCompletionTime", "distributionType", "responsibleList" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "flowData": { "type": "object", "description": "| Field values for modifying the flow (detailed description provided below) ||" }, "id": { "type": "integer", "description": "| Identifier of the flow to be modified." }, "name": { "type": "string", "description": "| Name of the flow. Must be unique for each flow." }, "description": { "type": "string", "description": "| Description of the flow ||" }, "groupId": { "type": "integer", "description": "| Identifier of the group to which the flow will be linked." }, "ownerId": { "type": "integer", "description": "| Identifier of the flow administrator." }, "templateId": { "type": "integer", "description": "| Identifier of the template that users will use to add tasks to the flow ||" }, "plannedCompletionTime": { "type": "integer", "description": "| Planned time to complete the task in seconds ||" }, "distributionType": { "type": "string", "description": "| Type of distribution:" }, "responsibleList": { "type": "array", "items": {}, "description": "| Identifiers of employees who will receive tasks." }, "taskCreators": { "type": "object", "description": "| List of users who can add tasks to the flow in the format `{\"\": \"\"}`. For example:" }, "matchWorkTime": { "type": "integer", "description": "| Skip weekends and holidays when calculating the task deadline." }, "responsibleCanChangeDeadline": { "type": "integer", "description": "| Can the responsible person change the task deadline?" }, "notifyAtHalfTime": { "type": "integer", "description": "| Notify the assignee at half the task deadline." }, "taskControl": { "type": "integer", "description": "| Send the completed task to the creator for review." }, "notifyOnQueueOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in the queue exceeds this parameter." }, "notifyOnTasksInProgressOverflow": { "type": "integer", "description": "| Notify the flow administrator when the number of tasks in progress exceeds this parameter." }, "notifyWhenEfficiencyDecreases": { "type": "integer", "description": "| Notify the flow administrator when efficiency drops below this parameter." } }, "required": [ "flowData", "id", "plannedCompletionTime", "distributionType", "responsibleList" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.access.field.get": { "post": { "summary": "Get Task Access Field Permissions tasks.task.access.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.access.field.get` returns the description of the task access field by name.", "operationId": "tasks_task_access_field_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.access.field.list": { "post": { "summary": "Get the List of Access Permission Fields for tasks.task.access.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.access.field.list` returns a list of available access permission fields for tasks.", "operationId": "tasks_task_access_field_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.access.get": { "post": { "summary": "Check Access Permissions tasks.task.access.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.access.get` checks the available actions a user can perform on a task.", "operationId": "tasks_task_access_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.add": { "post": { "summary": "Add Task tasks.task.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.add` adds a new task.", "operationId": "tasks_task_add", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Task fields. To create a task, fill in the required fields; without them, the creation operation will not be executed." }, "title": { "type": "string", "description": "| Task title ||" }, "creatorId": { "type": "integer", "description": "| Creator's identifier." }, "responsibleId": { "type": "integer", "description": "| Executor's identifier." } }, "required": [ "fields", "title", "creatorId", "responsibleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Task fields. To create a task, fill in the required fields; without them, the creation operation will not be executed." }, "title": { "type": "string", "description": "| Task title ||" }, "creatorId": { "type": "integer", "description": "| Creator's identifier." }, "responsibleId": { "type": "integer", "description": "| Executor's identifier." } }, "required": [ "fields", "title", "creatorId", "responsibleId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.approve": { "post": { "summary": "Approve Task tasks.task.approve", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.approve` accepts the work of the assignee on a task when task control is enabled and changes the task status to Completed. You can check the permission to accept the work of the assignee on the task using the [check access to the task](./tasks-task-get-access.md) method.", "operationId": "tasks_task_approve", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-approve.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.chat.message.field.get": { "post": { "summary": "Get Chat Message Field of Task tasks.task.chat.message.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.chat.message.field.get` returns the description of a chat message field for a task by name.", "operationId": "tasks_task_chat_message_field_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.chat.message.field.list": { "post": { "summary": "Get the List of Chat Message Fields for tasks.task.chat.message.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.chat.message.field.list` returns a list of available fields for a task chat message.", "operationId": "tasks_task_chat_message_field_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.chat.message.send": { "post": { "summary": "Send a Message in Task Chat tasks.task.chat.message.send", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.chat.message.send` sends a new message to the task chat.", "operationId": "tasks_task_chat_message_send", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with message parameters ||" }, "taskId": { "type": "integer", "description": "| The identifier of the task to which the message should be sent." }, "text": { "type": "string", "description": "| The message text ||" } }, "required": [ "fields", "taskId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| An object with message parameters ||" }, "taskId": { "type": "integer", "description": "| The identifier of the task to which the message should be sent." }, "text": { "type": "string", "description": "| The message text ||" } }, "required": [ "fields", "taskId", "text" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.complete": { "post": { "summary": "Translate task to Completed status tasks.task.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.complete` changes the task status to Completed.", "operationId": "tasks_task_complete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.counters.get": { "post": { "summary": "Get User Task Counters tasks.task.counters.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.counters.get` retrieves task counter values for the specified user.", "operationId": "tasks_task_counters_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-counters-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "integer", "description": "| The identifier of the user for whom to retrieve counters." }, "groupId": { "type": "integer", "description": "| The identifier of the group for which to retrieve task counters." }, "type": { "type": "string", "description": "| The role for which to retrieve counters. Possible roles:" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "userId": { "type": "integer", "description": "| The identifier of the user for whom to retrieve counters." }, "groupId": { "type": "integer", "description": "| The identifier of the group for which to retrieve task counters." }, "type": { "type": "string", "description": "| The role for which to retrieve counters. Possible roles:" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.defer": { "post": { "summary": "Translate the task to Deferred status tasks.task.defer", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.defer` changes the task status to Deferred.", "operationId": "tasks_task_defer", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-defer.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.delegate": { "post": { "summary": "Delegate Task tasks.task.delegate", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.delegate` changes the responsible person and delegates the task to another user. You can check the right to delegate a task using the [check access to the task](./tasks-task-get-access.md) method.", "operationId": "tasks_task_delegate", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-delegate.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." }, "userId": { "type": "integer", "description": "| Identifier of the user to whom the task is delegated." } }, "required": [ "taskId", "userId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." }, "userId": { "type": "integer", "description": "| Identifier of the user to whom the task is delegated." } }, "required": [ "taskId", "userId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.delete": { "post": { "summary": "Delete Task tasks.task.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.delete` removes a task. You can check the permission to delete a task using the [task access check method](./tasks-task-access-get.md).", "operationId": "tasks_task_delete", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.disapprove": { "post": { "summary": "Disapprove Task tasks.task.disapprove", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.disapprove` disapproves a task and returns it for revision to the assignee when task control is enabled. You can check the permission to disapprove the assignee's work on the task using the [task access check method](./tasks-task-get-access.md).", "operationId": "tasks_task_disapprove", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-disapprove.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.favorite.add": { "post": { "summary": "Add Task to Favorites tasks.task.favorite.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.favorite.add` adds a task to Favorites.", "operationId": "tasks_task_favorite_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-favorite-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.favorite.remove": { "post": { "summary": "Remove Task from Favorites tasks.task.favorite.remove", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.favorite.remove` removes a task from Favorites.", "operationId": "tasks_task_favorite_remove", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-favorite-remove.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.field.get": { "post": { "summary": "Get Task Field tasks.task.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.field.get` returns the description of a task field by name.", "operationId": "tasks_task_field_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.field.list": { "post": { "summary": "Get the List of Task Fields tasks.task.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.field.list` returns a list of available task fields.", "operationId": "tasks_task_field_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of field descriptions to be returned in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of field descriptions to be returned in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.file.attach": { "post": { "summary": "Attach Files to a Task tasks.task.file.attach", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.file.attach` adds files from Drive to a task. The user must have read access to the file or higher.", "operationId": "tasks_task_file_attach", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-attach.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task to which files need to be attached." }, "fileIds": { "type": "string", "description": "| An array of file identifiers from Drive." } }, "required": [ "taskId", "fileIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task to which files need to be attached." }, "fileIds": { "type": "string", "description": "| An array of file identifiers from Drive." } }, "required": [ "taskId", "fileIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.file.field.get": { "post": { "summary": "Get Task File Field Description: tasks.task.file.field.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.file.field.get` returns the description of a task file field by name.", "operationId": "tasks_task_file_field_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-field-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "| The name of the field whose description is to be retrieved ||" }, "select": { "type": "array", "items": {}, "description": "| A list of description fields to return in the response." } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.file.field.list": { "post": { "summary": "Get the List of Task File Fields: tasks.task.file.field.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.file.field.list` returns a list of available fields for task files.", "operationId": "tasks_task_file_field_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-field-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "select": { "type": "array", "items": {}, "description": "| List of description fields to return in the response." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.files.attach": { "post": { "summary": "Attach Files to Task tasks.task.files.attach", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.files.attach` adds a file from Disk to a task. The user must have read access or higher to the file.", "operationId": "tasks_task_files_attach", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-files-attach.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task to which the file needs to be attached." }, "fileId": { "type": "integer", "description": "| The identifier of the file on Disk." } }, "required": [ "taskId", "fileId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task to which the file needs to be attached." }, "fileId": { "type": "integer", "description": "| The identifier of the file on Disk." } }, "required": [ "taskId", "fileId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.get": { "post": { "summary": "Get Task tasks.task.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.get` returns information about a task by its identifier. Access to the data depends on permissions: - Administrators can see all tasks,", "operationId": "tasks_task_get", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." }, "select": { "type": "array", "items": {}, "description": "| An array of fields that the method will return. If `select` is not specified, a basic set of task fields without related objects is returned." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." }, "select": { "type": "array", "items": {}, "description": "| An array of fields that the method will return. If `select` is not specified, a basic set of task fields without related objects is returned." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.getFields": { "post": { "summary": "Get the list of fields tasks.task.getFields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.getFields` returns the description of standard and custom fields of a task.", "operationId": "tasks_task_getFields", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-get-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.getaccess": { "post": { "summary": "Check Access to Task tasks.task.getaccess", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.getaccess` checks the available actions for users on a task.", "operationId": "tasks_task_getaccess", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-get-access.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." }, "users": { "type": "array", "items": {}, "description": "| Array of user identifiers for which access needs to be checked." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." }, "users": { "type": "array", "items": {}, "description": "| Array of user identifiers for which access needs to be checked." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.history.list": { "post": { "summary": "Get Task History tasks.task.history.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.history.list` retrieves the history of changes for a task.", "operationId": "tasks_task_history_list", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-history-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task for which to retrieve the history." }, "filter": { "type": "object", "description": "| Filter by event type in the format `{FIELD: 'EVENT'}`. A list of possible values for `FIELD` is described below" }, "order": { "type": "object", "description": "| An object for sorting the result in the form `{\"field\": \"sort value\", ... }`." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| The identifier of the task for which to retrieve the history." }, "filter": { "type": "object", "description": "| Filter by event type in the format `{FIELD: 'EVENT'}`. A list of possible values for `FIELD` is described below" }, "order": { "type": "object", "description": "| An object for sorting the result in the form `{\"field\": \"sort value\", ... }`." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.list": { "post": { "summary": "Get the list of tasks tasks.task.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.list` retrieves a list of tasks with pagination. Access to the data depends on permissions: - administrators see all tasks,", "operationId": "tasks_task_list", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "select": { "type": "array", "items": {}, "description": "| An array containing a list of fields to be selected." }, "params": { "type": "object", "description": "| Additional information that can be retrieved about the task:" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "object", "description": "| An object for filtering the list of tasks in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`. The filterable field can take the following values:" }, "select": { "type": "array", "items": {}, "description": "| An array containing a list of fields to be selected." }, "params": { "type": "object", "description": "| Additional information that can be retrieved about the task:" }, "start": { "type": "integer", "description": "| This parameter is used to control pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.mute": { "post": { "summary": "Enable \"Mute\" Mode tasks.task.mute", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.mute` enables \"Mute\" mode for a task.", "operationId": "tasks_task_mute", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-mute.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.pause": { "post": { "summary": "Translate task to Waiting for execution status tasks.task.pause", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.pause` stops the execution of the task and changes its status to Waiting for execution.", "operationId": "tasks_task_pause", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-pause.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.pin": { "post": { "summary": "Pin a task tasks.task.pin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `tasks.task.pin` method pins a task in the current user's task list.", "operationId": "tasks_task_pin", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-pin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.renew": { "post": { "summary": "Renew a task after its completion tasks.task.renew", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.renew` resumes a task after it has been completed.", "operationId": "tasks_task_renew", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-renew.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.add": { "post": { "summary": "Add Result to Task tasks.task.result.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so the assistant can use the official REST documentation. The method `tasks.task.result.add` adds a result to a task.", "operationId": "tasks_task_result_add", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with result fields ||" }, "taskId": { "type": "integer", "description": "| Task identifier." }, "text": { "type": "string", "description": "| Result text ||" } }, "required": [ "fields", "taskId", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with result fields ||" }, "taskId": { "type": "integer", "description": "| Task identifier." }, "text": { "type": "string", "description": "| Result text ||" } }, "required": [ "fields", "taskId", "text" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.addFromComment": { "post": { "summary": "Add Comment to Result tasks.task.result.addFromComment", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.result.addFromComment` pins a comment as the result of a task. A user can pin only their own comment as a result. An administrator can pin any user's comment, becoming the author of the result. When working with the [new task detail form](../tasks-new.md) with chat from version `tasks 25.700.0`, the method does not work.", "operationId": "tasks_task_result_addFromComment", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/result/tasks-task-result-add-from-comment.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| The identifier of the comment to be pinned as the result." } }, "required": [ "commentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| The identifier of the comment to be pinned as the result." } }, "required": [ "commentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.addfromchatmessage": { "post": { "summary": "Add Result from Task Chat Message tasks.task.result.addfromchatmessage", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant uses the official REST documentation. The method `tasks.task.result.addfromchatmessage` creates a task result from a task chat message.", "operationId": "tasks_task_result_addfromchatmessage", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-addfromchatmessage.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with message fields ||" }, "messageId": { "type": "integer", "description": "| Identifier of the task chat message." } }, "required": [ "fields", "messageId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Object with message fields ||" }, "messageId": { "type": "integer", "description": "| Identifier of the task chat message." } }, "required": [ "fields", "messageId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.delete": { "post": { "summary": "Delete Task Result tasks.task.result.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.delete` deletes the task result.", "operationId": "tasks_task_result_delete", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the result ||" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the result ||" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.deleteFromComment": { "post": { "summary": "Remove Comment from Result tasks.task.result.deleteFromComment", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.result.deleteFromComment` removes the pinning of a comment as the result of a task. To delete a comment from the result, use the method [task.commentitem.delete](../comment-item/task-comment-item-delete.md). A user can only unpin their own comment. An administrator can unpin any user's comment. When working with the [new task detail form](../tasks-new.md) with chat from version `tasks 25.700.0`, the method does not work.", "operationId": "tasks_task_result_deleteFromComment", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/result/tasks-task-result-delete-from-comment.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| The identifier of the comment for which the result needs to be unpinned." } }, "required": [ "commentId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "commentId": { "type": "integer", "description": "| The identifier of the comment for which the result needs to be unpinned." } }, "required": [ "commentId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.result.list": { "post": { "summary": "Get the list of task results tasks.task.result.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.list` returns a list of task results.", "operationId": "tasks_task_result_list", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the list of results in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| An array of conditions for filtering the list of results. Be sure to pass the condition for `taskId`." }, "select": { "type": "array", "items": {}, "description": "| An array of fields to select." }, "pagination": { "type": "object", "description": "| An object for managing pagination." } }, "required": [ "filter" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "object", "description": "| An object for sorting the list of results in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| An array of conditions for filtering the list of results. Be sure to pass the condition for `taskId`." }, "select": { "type": "array", "items": {}, "description": "| An array of fields to select." }, "pagination": { "type": "object", "description": "| An object for managing pagination." } }, "required": [ "filter" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.result.update": { "post": { "summary": "Update Task Result tasks.task.result.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.update` updates the text of the task result.", "operationId": "tasks_task_result_update", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the result ||" }, "fields": { "type": "object", "description": "| Object with result fields ||" }, "text": { "type": "string", "description": "| New text of the result ||" } }, "required": [ "id", "fields", "text" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the result ||" }, "fields": { "type": "object", "description": "| Object with result fields ||" }, "text": { "type": "string", "description": "| New text of the result ||" } }, "required": [ "id", "fields", "text" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.task.start": { "post": { "summary": "Translate the task to In Progress status tasks.task.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.start` changes the task status to In Progress.", "operationId": "tasks_task_start", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.startwatch": { "post": { "summary": "Enable Task Watching tasks.task.startwatch", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.startwatch` enables watching a task.", "operationId": "tasks_task_startwatch", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-start-watch.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.stopwatch": { "post": { "summary": "Disable Task Stopwatch tasks.task.stopwatch", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.stopwatch` disables the stopwatch for the task.", "operationId": "tasks_task_stopwatch", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-stop-watch.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "taskId": { "type": "integer", "description": "| Task identifier." } }, "required": [ "taskId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.unmute": { "post": { "summary": "Disable \"Mute\" mode tasks.task.unmute", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.unmute` disables the \"Mute\" mode for a task.", "operationId": "tasks_task_unmute", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-unmute.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.unpin": { "post": { "summary": "Unpin a task tasks.task.unpin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `tasks.task.unpin` method unpins a task in the current user's task list.", "operationId": "tasks_task_unpin", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/tasks-task-unpin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.task.update": { "post": { "summary": "Update Task tasks.task.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.task.update` updates a task.", "operationId": "tasks_task_update", "tags": [ "REST v3" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." }, "fields": { "type": "object", "description": "| Values of the task fields to be updated." } }, "required": [ "id", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Task identifier." }, "fields": { "type": "object", "description": "| Values of the task fields to be updated." } }, "required": [ "id", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "tasks" ] } ] } }, "/tasks.template.add": { "post": { "summary": "Add Task Template tasks.template.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.add` creates a new task template.", "operationId": "tasks_template_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/tasks-template-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields of the new task template (detailed description)." } }, "required": [ "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Fields of the new task template (detailed description)." } }, "required": [ "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.add": { "post": { "summary": "Add Checklist Item to Task Template tasks.template.checklist.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.add` adds a checklist item to a task template.", "operationId": "tasks_template_checklist_add", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "fields": { "type": "object", "description": "| Fields of the checklist item being created (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" } }, "required": [ "templateId", "fields", "TITLE", "PARENT_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "fields": { "type": "object", "description": "| Fields of the checklist item being created (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item." }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" } }, "required": [ "templateId", "fields", "TITLE", "PARENT_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.addAttachmentByContent": { "post": { "summary": "Add Attachment to Checklist Item Using tasks.template.checklist.addAttachmentByContent", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.addAttachmentByContent` adds an attachment to a checklist item based on the file's content.", "operationId": "tasks_template_checklist_addAttachmentByContent", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachment-by-content.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "attachmentParameters": { "type": "object", "description": "| Parameters for the created attachment (detailed description) ||" }, "NAME": { "type": "string", "description": "| Name of the created file ||" }, "CONTENT": { "type": "string", "description": "| Content of the file in base64 format ||" } }, "required": [ "templateId", "checkListItemId", "attachmentParameters" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "attachmentParameters": { "type": "object", "description": "| Parameters for the created attachment (detailed description) ||" }, "NAME": { "type": "string", "description": "| Name of the created file ||" }, "CONTENT": { "type": "string", "description": "| Content of the file in base64 format ||" } }, "required": [ "templateId", "checkListItemId", "attachmentParameters" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.addAttachmentsFromDisk": { "post": { "summary": "Add Attachments from Drive to Checklist Item tasks.template.checklist.addAttachmentsFromDisk", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.addAttachmentsFromDisk` adds files from Drive to a checklist item.", "operationId": "tasks_template_checklist_addAttachmentsFromDisk", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-add-attachments-from-disk.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "filesIds": { "type": "array", "items": {}, "description": "| An array of file identifiers from Drive. Prefix each identifier with `n`, for example, `[\"n5065\", \"n5067\"]`." } }, "required": [ "templateId", "checkListItemId", "filesIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "filesIds": { "type": "array", "items": {}, "description": "| An array of file identifiers from Drive. Prefix each identifier with `n`, for example, `[\"n5065\", \"n5067\"]`." } }, "required": [ "templateId", "checkListItemId", "filesIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.complete": { "post": { "summary": "Complete Checklist Item of Task Template tasks.template.checklist.complete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.complete` marks a checklist item of the template as completed.", "operationId": "tasks_template_checklist_complete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-complete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.delete": { "post": { "summary": "Delete Checklist Item from Task Template tasks.template.checklist.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.delete` removes a checklist item from the task template.", "operationId": "tasks_template_checklist_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.get": { "post": { "summary": "Get Checklist Item of Task Template tasks.template.checklist.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.get` returns a single checklist item from the task template.", "operationId": "tasks_template_checklist_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item in the template." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item in the template." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.list": { "post": { "summary": "Get the List of Checklist Items for Task Template tasks.template.checklist.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.list` returns a list of checklist items for a task template.", "operationId": "tasks_template_checklist_list", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "filter": { "type": "object", "description": "| Filter for selecting checklist items in the form `{ \"field\": \"value\", ... }`." }, "select": { "type": "array", "items": {}, "description": "| List of fields to select." }, "order": { "type": "object", "description": "| Object for sorting the result in the form `{ \"field\": \"sort value\", ... }`." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "filter": { "type": "object", "description": "| Filter for selecting checklist items in the form `{ \"field\": \"value\", ... }`." }, "select": { "type": "array", "items": {}, "description": "| List of fields to select." }, "order": { "type": "object", "description": "| Object for sorting the result in the form `{ \"field\": \"sort value\", ... }`." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.moveAfter": { "post": { "summary": "Move Checklist Item After Another tasks.template.checklist.moveAfter", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.moveAfter` moves a checklist item after a specified item.", "operationId": "tasks_template_checklist_moveAfter", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-move-after.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the item to be moved." }, "afterItemId": { "type": "integer", "description": "| Identifier of the item after which the element should be placed ||" } }, "required": [ "templateId", "checkListItemId", "afterItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the item to be moved." }, "afterItemId": { "type": "integer", "description": "| Identifier of the item after which the element should be placed ||" } }, "required": [ "templateId", "checkListItemId", "afterItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.moveBefore": { "post": { "summary": "Move Checklist Item Before Another Item: tasks.template.checklist.moveBefore", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.moveBefore` moves a checklist item before the specified item.", "operationId": "tasks_template_checklist_moveBefore", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-move-before.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| The identifier of the item to be moved." }, "beforeItemId": { "type": "integer", "description": "| The identifier of the item before which the element should be placed." } }, "required": [ "templateId", "checkListItemId", "beforeItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| The identifier of the item to be moved." }, "beforeItemId": { "type": "integer", "description": "| The identifier of the item before which the element should be placed." } }, "required": [ "templateId", "checkListItemId", "beforeItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.removeAttachments": { "post": { "summary": "Remove Attachments from Checklist Item tasks.template.checklist.removeAttachments", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.removeAttachments` removes attachments from a checklist item in the task template.", "operationId": "tasks_template_checklist_removeAttachments", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-remove-attachments.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| The identifier of the checklist item." }, "attachmentsIds": { "type": "array", "items": {}, "description": "| An array of attachment identifiers to be removed ||" } }, "required": [ "templateId", "checkListItemId", "attachmentsIds" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| The identifier of the checklist item." }, "attachmentsIds": { "type": "array", "items": {}, "description": "| An array of attachment identifiers to be removed ||" } }, "required": [ "templateId", "checkListItemId", "attachmentsIds" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.renew": { "post": { "summary": "Renew Checklist Item of Task Template tasks.template.checklist.renew", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.renew` removes the completion mark from a checklist item of the task template.", "operationId": "tasks_template_checklist_renew", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-renew.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." } }, "required": [ "templateId", "checkListItemId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.checklist.update": { "post": { "summary": "Update Checklist Item of Task Template tasks.template.checklist.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.checklist.update` updates a checklist item of the task template.", "operationId": "tasks_template_checklist_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/checklist/tasks-template-checklist-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "fields": { "type": "object", "description": "| Fields to update the checklist item (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists" }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Completion status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" } }, "required": [ "templateId", "checkListItemId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "checkListItemId": { "type": "integer", "description": "| Identifier of the checklist item." }, "fields": { "type": "object", "description": "| Fields to update the checklist item (detailed description) ||" }, "TITLE": { "type": "string", "description": "| Text of the checklist item" }, "PARENT_ID": { "type": "integer", "description": "| Identifier of the parent item. Use for nested checklists" }, "SORT_INDEX": { "type": "integer", "description": "| Sort index. The lower the value, the higher the item in the list or sublist ||" }, "IS_COMPLETE": { "type": "boolean", "description": "| Completion status of the item. Possible values:" }, "IS_IMPORTANT": { "type": "boolean", "description": "| Mark indicating that the item is important. Possible values:" }, "MEMBERS": { "type": "object", "description": "| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:" } }, "required": [ "templateId", "checkListItemId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.delete": { "post": { "summary": "Delete Task Template tasks.template.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.delete` removes a task template.", "operationId": "tasks_template_delete", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/tasks-template-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.fields": { "post": { "summary": "Get the List of Task Template Fields tasks.template.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.fields` returns the description of the task template fields.", "operationId": "tasks_template_fields", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/tasks-template-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.get": { "post": { "summary": "Get Task Template by ID tasks.template.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.get` returns the task template data by its ID.", "operationId": "tasks_template_get", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/tasks-template-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The ID of the task template." }, "params": { "type": "object", "description": "| Additional selection parameters (detailed description) ||" }, "select": { "type": "array", "items": {}, "description": "| An array of fields to return." } }, "required": [ "templateId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| The ID of the task template." }, "params": { "type": "object", "description": "| Additional selection parameters (detailed description) ||" }, "select": { "type": "array", "items": {}, "description": "| An array of fields to return." } }, "required": [ "templateId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/tasks.template.update": { "post": { "summary": "Update Task Template tasks.template.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `tasks.template.update` updates an existing task template.", "operationId": "tasks_template_update", "tags": [ "Tasks" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/tasks/template/tasks-template-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "fields": { "type": "object", "description": "| Fields of the template that need to be modified." } }, "required": [ "templateId", "fields" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "templateId": { "type": "integer", "description": "| Identifier of the task template." }, "fields": { "type": "object", "description": "| Fields of the template that need to be modified." } }, "required": [ "templateId", "fields" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "task" ] } ] } }, "/telephony.call.attachTranscription": { "post": { "summary": "Add Transcription to Call with telephony.call.attachTranscription", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.call.attachTranscription` adds a transcription of the conversation to a completed call.", "operationId": "telephony_call_attachTranscription", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-call-attach-transcription.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register ||" }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of transcription utterances ||" }, "COST": { "type": "number", "format": "double", "description": "| Cost of the transcription." }, "COST_CURRENCY": { "type": "string", "description": "| Currency of the transcription cost. Used only with `COST`." }, "SIDE": { "type": "string", "description": "| Participant of the conversation." }, "START_TIME": { "type": "integer", "description": "| Start time of the utterance in seconds from the beginning of the call." }, "STOP_TIME": { "type": "integer", "description": "| End time of the utterance in seconds from the beginning of the call." }, "MESSAGE": { "type": "string", "description": "| Text of the utterance ||" } }, "required": [ "CALL_ID", "MESSAGES", "SIDE", "START_TIME", "STOP_TIME", "MESSAGE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register ||" }, "MESSAGES": { "type": "array", "items": {}, "description": "| Array of transcription utterances ||" }, "COST": { "type": "number", "format": "double", "description": "| Cost of the transcription." }, "COST_CURRENCY": { "type": "string", "description": "| Currency of the transcription cost. Used only with `COST`." }, "SIDE": { "type": "string", "description": "| Participant of the conversation." }, "START_TIME": { "type": "integer", "description": "| Start time of the utterance in seconds from the beginning of the call." }, "STOP_TIME": { "type": "integer", "description": "| End time of the utterance in seconds from the beginning of the call." }, "MESSAGE": { "type": "string", "description": "| Text of the utterance ||" } }, "required": [ "CALL_ID", "MESSAGES", "SIDE", "START_TIME", "STOP_TIME", "MESSAGE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.attachRecord": { "post": { "summary": "Attach a Record to a Completed Call telephony.externalCall.attachRecord", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.attachRecord` attaches a record to a completed call and to the CRM activity of the call. Call this method after [telephony.externalCall.finish](./telephony-external-call-finish.md) when the record is ready.", "operationId": "telephony_externalCall_attachRecord", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-attach-record.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| The identifier of the call from the method telephony.externalCall.register." }, "RECORD_URL": { "type": "string", "description": "| The URL of the record on an external server. If this parameter is provided, Bitrix24 will download the file from the link." }, "FILENAME": { "type": "string", "description": "| The name of the record file." }, "FILE_CONTENT": { "type": "string", "description": "| The file in Base64 encoding. ||" } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| The identifier of the call from the method telephony.externalCall.register." }, "RECORD_URL": { "type": "string", "description": "| The URL of the record on an external server. If this parameter is provided, Bitrix24 will download the file from the link." }, "FILENAME": { "type": "string", "description": "| The name of the record file." }, "FILE_CONTENT": { "type": "string", "description": "| The file in Base64 encoding. ||" } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.finish": { "post": { "summary": "Finish Call and Log It in Telephony Statistics telephony.externalCall.finish", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.finish` ends an external call, saves it in the statistics, and logs it in the CRM activity. The method works only in the context of the [application](../../settings/app-installation/index.md)", "operationId": "telephony_externalCall_finish", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-finish.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| The identifier of the call from the method telephony.externalCall.register ||" }, "USER_ID": { "type": "integer", "description": "| The identifier of the user who ends the call." }, "USER_PHONE_INNER": { "type": "string", "description": "| The internal number of the user." }, "DURATION": { "type": "integer", "description": "| The duration of the call in seconds." }, "COST": { "type": "number", "format": "double", "description": "| The cost of the call." }, "COST_CURRENCY": { "type": "string", "description": "| The currency of the call cost." }, "STATUS_CODE": { "type": "string", "description": "| The result code of the call." }, "FAILED_REASON": { "type": "string", "description": "| Text reason for the failed call." }, "RECORD_URL": { "type": "string", "description": "| URL of the call recording." }, "VOTE": { "type": "integer", "description": "| Rating of the call." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Add a message about the call to the employee's chat." } }, "required": [ "CALL_ID", "USER_ID", "USER_PHONE_INNER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| The identifier of the call from the method telephony.externalCall.register ||" }, "USER_ID": { "type": "integer", "description": "| The identifier of the user who ends the call." }, "USER_PHONE_INNER": { "type": "string", "description": "| The internal number of the user." }, "DURATION": { "type": "integer", "description": "| The duration of the call in seconds." }, "COST": { "type": "number", "format": "double", "description": "| The cost of the call." }, "COST_CURRENCY": { "type": "string", "description": "| The currency of the call cost." }, "STATUS_CODE": { "type": "string", "description": "| The result code of the call." }, "FAILED_REASON": { "type": "string", "description": "| Text reason for the failed call." }, "RECORD_URL": { "type": "string", "description": "| URL of the call recording." }, "VOTE": { "type": "integer", "description": "| Rating of the call." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Add a message about the call to the employee's chat." } }, "required": [ "CALL_ID", "USER_ID", "USER_PHONE_INNER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.hide": { "post": { "summary": "Hide Call Card for User telephony.externalCall.hide", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.hide` hides the call card for a user or a list of users.", "operationId": "telephony_externalCall_hide", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-hide.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register. ||" }, "USER_ID": { "type": "string", "description": "| Identifier of the user or an array of user identifiers." } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register. ||" }, "USER_ID": { "type": "string", "description": "| Identifier of the user or an array of user identifiers." } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.register": { "post": { "summary": "Register an External Call in Bitrix24 telephony.externalCall.register", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.register` registers an external call in Bitrix24. To create a CRM activity for the call, you must also call the method [telephony.externalCall.finish](./telephony-external-call-finish.md). The method works only in the context of an [application](../../settings/app-installation/index.md).", "operationId": "telephony_externalCall_register", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-register.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user for whom the call is registered." }, "USER_PHONE_INNER": { "type": "string", "description": "| The internal number of the user." }, "PHONE_NUMBER": { "type": "string", "description": "| The client's phone number. ||" }, "TYPE": { "type": "integer", "description": "| The type of call." }, "CALL_START_DATE": { "type": "string", "description": "| The date and time the call started in ISO-8601 format with timezone indication, for example, `2026-03-07T10:20:30+03:00`." }, "CRM_CREATE": { "type": "integer", "description": "| Automatic creation of a CRM object if no suitable object is found by the number." }, "CRM_SOURCE": { "type": "string", "description": "| The identifier of the CRM source (the value of the `STATUS_ID` field)." }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| The type of CRM object to associate with the call." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| The identifier of the CRM object from `CRM_ENTITY_TYPE`." }, "SHOW": { "type": "integer", "description": "| Show the call detail form after registration." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Add a message about the call to the employee's chat." }, "CALL_LIST_ID": { "type": "integer", "description": "| The identifier of the call list to which the call is linked." }, "LINE_NUMBER": { "type": "string", "description": "| The number of the external line." }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| The external identifier of the call on the side of the PBX/integration." } }, "required": [ "USER_ID", "USER_PHONE_INNER", "PHONE_NUMBER", "TYPE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| The identifier of the user for whom the call is registered." }, "USER_PHONE_INNER": { "type": "string", "description": "| The internal number of the user." }, "PHONE_NUMBER": { "type": "string", "description": "| The client's phone number. ||" }, "TYPE": { "type": "integer", "description": "| The type of call." }, "CALL_START_DATE": { "type": "string", "description": "| The date and time the call started in ISO-8601 format with timezone indication, for example, `2026-03-07T10:20:30+03:00`." }, "CRM_CREATE": { "type": "integer", "description": "| Automatic creation of a CRM object if no suitable object is found by the number." }, "CRM_SOURCE": { "type": "string", "description": "| The identifier of the CRM source (the value of the `STATUS_ID` field)." }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| The type of CRM object to associate with the call." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| The identifier of the CRM object from `CRM_ENTITY_TYPE`." }, "SHOW": { "type": "integer", "description": "| Show the call detail form after registration." }, "ADD_TO_CHAT": { "type": "integer", "description": "| Add a message about the call to the employee's chat." }, "CALL_LIST_ID": { "type": "integer", "description": "| The identifier of the call list to which the call is linked." }, "LINE_NUMBER": { "type": "string", "description": "| The number of the external line." }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| The external identifier of the call on the side of the PBX/integration." } }, "required": [ "USER_ID", "USER_PHONE_INNER", "PHONE_NUMBER", "TYPE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.searchCrmEntities": { "post": { "summary": "Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.searchCrmEntities` returns CRM entities based on the client's phone number and the details of the responsible employee.", "operationId": "telephony_externalCall_searchCrmEntities", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-search-crm-entities.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PHONE_NUMBER": { "type": "string", "description": "| The client's phone number ||" } }, "required": [ "PHONE_NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "PHONE_NUMBER": { "type": "string", "description": "| The client's phone number ||" } }, "required": [ "PHONE_NUMBER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalCall.show": { "post": { "summary": "Show Call Card to User telephony.externalCall.show", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalCall.show` displays the call card to a user or a list of users.", "operationId": "telephony_externalCall_show", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-call-show.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register ||" }, "USER_ID": { "type": "string", "description": "| Identifier of the user or an array of user identifiers." } }, "required": [ "CALL_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CALL_ID": { "type": "string", "description": "| Identifier of the call from the method telephony.externalCall.register ||" }, "USER_ID": { "type": "string", "description": "| Identifier of the user or an array of user identifiers." } }, "required": [ "CALL_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.add": { "post": { "summary": "Add External Line telephony.externalLine.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.add` adds an external line to the application. The method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "telephony_externalLine_add", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| External line number ||" }, "NAME": { "type": "string", "description": "| Name of the external line ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Auto-creation of a CRM object for outgoing calls." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| External line number ||" }, "NAME": { "type": "string", "description": "| Name of the external line ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Auto-creation of a CRM object for outgoing calls." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.delete": { "post": { "summary": "Delete External Line telephony.externalLine.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.delete` removes an external line from the application. The method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "telephony_externalLine_delete", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| The number of the external line." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| The number of the external line." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.get": { "post": { "summary": "Get a List of External Lines with telephony.externalLine.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.get` returns a list of external lines for the application. The method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "telephony_externalLine_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/telephony.externalLine.update": { "post": { "summary": "Update External Line telephony.externalLine.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `telephony.externalLine.update` modifies the parameters of the application's external line. This method works only in the context of the [application](../../settings/app-installation/index.md).", "operationId": "telephony_externalLine_update", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/telephony-external-line-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| The number of the external line." }, "NAME": { "type": "string", "description": "| The new name of the external line. ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Auto-creation of a CRM object for outgoing calls." } }, "required": [ "NUMBER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "NUMBER": { "type": "string", "description": "| The number of the external line." }, "NAME": { "type": "string", "description": "| The new name of the external line. ||" }, "CRM_AUTO_CREATE": { "type": "string", "description": "| Auto-creation of a CRM object for outgoing calls." } }, "required": [ "NUMBER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/timeman.close": { "post": { "summary": "Close Current Day timeman.close", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.close` ends the current workday.", "operationId": "timeman_close", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/base/timeman-close.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." }, "TIME": { "type": "string", "format": "date-time", "description": "| The end time and date of the workday in the ATOM (ISO-8601) format, for example, `2025-02-12T15:52:01+00:00`. The date must match the start date of the workday." }, "REPORT": { "type": "string", "description": "| Reason for changing the workday." }, "LAT": { "type": "number", "format": "double", "description": "| Geographic latitude of the end of the workday ||" }, "LON": { "type": "number", "format": "double", "description": "| Geographic longitude of the end of the workday ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." }, "TIME": { "type": "string", "format": "date-time", "description": "| The end time and date of the workday in the ATOM (ISO-8601) format, for example, `2025-02-12T15:52:01+00:00`. The date must match the start date of the workday." }, "REPORT": { "type": "string", "description": "| Reason for changing the workday." }, "LAT": { "type": "number", "format": "double", "description": "| Geographic latitude of the end of the workday ||" }, "LON": { "type": "number", "format": "double", "description": "| Geographic longitude of the end of the workday ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.check": { "post": { "summary": "Check IP Address timeman.networkrange.check", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.networkrange.check` checks whether an IP address falls within the ranges of the office network. For the method to work correctly, at least one range must be set.", "operationId": "timeman_networkrange_check", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/networkrange/timeman-networkrange-check.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "IP": { "type": "string", "description": "| The IP address to check. For example, `10.10.255.25`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "IP": { "type": "string", "description": "| The IP address to check. For example, `10.10.255.25`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.get": { "post": { "summary": "Get Network Address Ranges timeman.networkrange.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.networkrange.get` retrieves the ranges of network addresses for the office network.", "operationId": "timeman_networkrange_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/networkrange/timeman-networkrange-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.networkrange.set": { "post": { "summary": "Set Network Address Ranges timeman.networkrange.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.networkrange.set` sets the network address ranges for the office network.", "operationId": "timeman_networkrange_set", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/networkrange/timeman-networkrange-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "RANGES": { "type": "string", "description": "| Network address ranges in the form of a list of objects. Each object contains a description of the network address range." } }, "required": [ "RANGES" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "RANGES": { "type": "string", "description": "| Network address ranges in the form of a list of objects. Each object contains a description of the network address range." } }, "required": [ "RANGES" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.open": { "post": { "summary": "Start a New Workday timeman.open", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.open` starts a new workday or continues the workday after a break or completion.", "operationId": "timeman_open", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/base/timeman-open.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." }, "TIME": { "type": "string", "format": "date-time", "description": "| The start date and time of the workday in the ATOM (ISO-8601) format, for example, `2025-02-12T15:52:01+00:00`. The date must match the current calendar date." }, "REPORT": { "type": "string", "description": "| Reason for changing the workday." }, "LAT": { "type": "number", "format": "double", "description": "| Geographic latitude of the start of the workday ||" }, "LON": { "type": "number", "format": "double", "description": "| Geographic longitude of the start of the workday ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." }, "TIME": { "type": "string", "format": "date-time", "description": "| The start date and time of the workday in the ATOM (ISO-8601) format, for example, `2025-02-12T15:52:01+00:00`. The date must match the current calendar date." }, "REPORT": { "type": "string", "description": "| Reason for changing the workday." }, "LAT": { "type": "number", "format": "double", "description": "| Geographic latitude of the start of the workday ||" }, "LON": { "type": "number", "format": "double", "description": "| Geographic longitude of the start of the workday ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.pause": { "post": { "summary": "Pause the current workday timeman.pause", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.pause` pauses the current workday. If the workday is completed, the method will resume it and add the time that has passed since completion to the duration.", "operationId": "timeman_pause", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/base/timeman-pause.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.schedule.get": { "post": { "summary": "Get Work Schedule timeman.schedule.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.schedule.get` retrieves the work schedule by its identifier. If no schedule exists with the specified identifier, it will return an empty array.", "operationId": "timeman_schedule_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/schedule/timeman-schedule-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the schedule." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the schedule." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.settings": { "post": { "summary": "Get User Work Time Settings timeman.settings", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.settings` retrieves the user's work time settings.", "operationId": "timeman_settings", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/base/timeman-settings.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.status": { "post": { "summary": "Get information about the current workday timeman.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.status` retrieves information about the current workday.", "operationId": "timeman_status", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/base/timeman-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.report.add": { "post": { "summary": "Add Absence Report timeman.timecontrol.report.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.report.add` sends an absence report and adds it to the calendar. By default, a user can only send a report for themselves. A portal administrator can send a report for anyone—this requires specifying the user ID in the `USER_ID` parameter.", "operationId": "timeman_timecontrol_report_add", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-report-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REPORT_ID": { "type": "string", "description": "\\| ID*" }, "USER_ID": { "type": "integer", "description": "| User identifier. Can only be specified by an administrator." }, "TEXT": { "type": "string", "description": "| Report text ||" }, "TYPE": { "type": "string", "description": "| Report type:" }, "CALENDAR": { "type": "string", "description": "| Add event to calendar:" } }, "required": [ "REPORT_ID", "TEXT" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REPORT_ID": { "type": "string", "description": "\\| ID*" }, "USER_ID": { "type": "integer", "description": "| User identifier. Can only be specified by an administrator." }, "TEXT": { "type": "string", "description": "| Report text ||" }, "TYPE": { "type": "string", "description": "| Report type:" }, "CALENDAR": { "type": "string", "description": "| Add event to calendar:" } }, "required": [ "REPORT_ID", "TEXT" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.get": { "post": { "summary": "Get Report on Identified Absences timeman.timecontrol.reports.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.reports.get` retrieves a report on identified absences.", "operationId": "timeman_timecontrol_reports_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-reports-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User ID for whom the reports are requested." }, "MONTH": { "type": "integer", "description": "| Month number ||" }, "YEAR": { "type": "integer", "description": "| Year ||" }, "IDLE_MINUTES": { "type": "integer", "description": "| Maximum time of absence at the workplace that is not counted as absence." }, "WORKDAY_HOURS": { "type": "integer", "description": "| Duration of the workday in hours." } }, "required": [ "USER_ID", "MONTH", "YEAR" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User ID for whom the reports are requested." }, "MONTH": { "type": "integer", "description": "| Month number ||" }, "YEAR": { "type": "integer", "description": "| Year ||" }, "IDLE_MINUTES": { "type": "integer", "description": "| Maximum time of absence at the workplace that is not counted as absence." }, "WORKDAY_HOURS": { "type": "integer", "description": "| Duration of the workday in hours." } }, "required": [ "USER_ID", "MONTH", "YEAR" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.settings.get": { "post": { "summary": "Get Report Settings timeman.timecontrol.reports.settings.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.reports.settings.get` retrieves report settings for building the report interface of the time control tool.", "operationId": "timeman_timecontrol_reports_settings_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-reports-settings-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.reports.users.get": { "post": { "summary": "Get the list of users for the timeman.timecontrol.reports.users.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.reports.users.get` retrieves the list of users in the department. The data returned by the method depends on the role: - an employee will receive only their own data,", "operationId": "timeman_timecontrol_reports_users_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-reports-users-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "DEPARTMENT_ID": { "type": "integer", "description": "| The identifier of the department. This parameter should only be specified by a manager or administrator." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "DEPARTMENT_ID": { "type": "integer", "description": "| The identifier of the department. This parameter should only be specified by a manager or administrator." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.settings.get": { "post": { "summary": "Get Time Control Settings timeman.timecontrol.settings.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.settings.get` retrieves the settings of the time control module.", "operationId": "timeman_timecontrol_settings_get", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-settings-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/timeman.timecontrol.settings.set": { "post": { "summary": "Set Time Control Settings timeman.timecontrol.settings.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `timeman.timecontrol.settings.set` sets the configurations for the time control module. Data collection for time control begins once the corresponding registration settings are activated. It is not possible to retrieve data for the period prior to activation — the system does not retain historical information retrospectively.", "operationId": "timeman_timecontrol_settings_set", "tags": [ "Time Management" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/timeman/timecontrol/timeman-timecontrol-settings-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "boolean", "description": "| Activate the time control module. Possible values:" }, "MINIMUM_IDLE_FOR_REPORT": { "type": "integer", "description": "| Minimum idle time in minutes after which a report is required ||" }, "REGISTER_OFFLINE": { "type": "boolean", "description": "| Register offline status ||" }, "REGISTER_IDLE": { "type": "boolean", "description": "| Register idle status ||" }, "REGISTER_DESKTOP": { "type": "boolean", "description": "| Register desktop application status ||" }, "REPORT_REQUEST_TYPE": { "type": "string", "description": "| Type of report requests. Possible values:" }, "REPORT_REQUEST_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs for whom report requests are required." }, "REPORT_SIMPLE_TYPE": { "type": "string", "description": "| Type of simple report. Possible values:" }, "REPORT_SIMPLE_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs with access to the simple report." }, "REPORT_FULL_TYPE": { "type": "string", "description": "| Type of full report. Possible values:" }, "REPORT_FULL_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs with access to the full report." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACTIVE": { "type": "boolean", "description": "| Activate the time control module. Possible values:" }, "MINIMUM_IDLE_FOR_REPORT": { "type": "integer", "description": "| Minimum idle time in minutes after which a report is required ||" }, "REGISTER_OFFLINE": { "type": "boolean", "description": "| Register offline status ||" }, "REGISTER_IDLE": { "type": "boolean", "description": "| Register idle status ||" }, "REGISTER_DESKTOP": { "type": "boolean", "description": "| Register desktop application status ||" }, "REPORT_REQUEST_TYPE": { "type": "string", "description": "| Type of report requests. Possible values:" }, "REPORT_REQUEST_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs for whom report requests are required." }, "REPORT_SIMPLE_TYPE": { "type": "string", "description": "| Type of simple report. Possible values:" }, "REPORT_SIMPLE_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs with access to the simple report." }, "REPORT_FULL_TYPE": { "type": "string", "description": "| Type of full report. Possible values:" }, "REPORT_FULL_USERS": { "type": "array", "items": {}, "description": "| Array of user IDs with access to the full report." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "timeman" ] } ] } }, "/user.access": { "post": { "summary": "Determine the user.access permissions set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `user.access` method checks if the current user has at least one of the permissions specified in the `ACCESS` parameter.", "operationId": "user_access", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/users/user-access.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "array", "items": {}, "description": "| Identifier or list of identifiers of the permissions to check access for ||" } }, "required": [ "ACCESS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ACCESS": { "type": "array", "items": {}, "description": "| Identifier or list of identifiers of the permissions to check access for ||" } }, "required": [ "ACCESS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/user.add": { "post": { "summary": "Add Users to Group sonet_group.user.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.add` adds users to a workgroup or project without an invitation and confirmation.", "operationId": "user_add", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| User identifier." } }, "required": [ "GROUP_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| User identifier." } }, "required": [ "GROUP_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.admin": { "post": { "summary": "Determine Access Permissions for Application Settings user.admin", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.admin` determines whether the current user has the permissions to manage application settings. No parameters.", "operationId": "user_admin", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/users/user-admin.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Returns `true` if the current user has permissions to manage application settings, `false` otherwise ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "boolean", "description": "| Returns `true` if the current user has permissions to manage application settings, `false` otherwise ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/user.current": { "post": { "summary": "Get Information About the Current User user.current", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.current` retrieves information about the [current](*current_key*) user. The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application's/webhook's scope. Details about user data access can be found in the [article](index.md). The method has no parameters. However, by making a REST request using data from `$_REQUEST` to the domain `DOMAIN` and adding `AUTH_ID` to the request for access to Bitrix24, you can find out which user opened the page in the context of Bitrix24.", "operationId": "user_current", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/user-current.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The root element of the response that contains information about the user ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| The root element of the response that contains information about the user ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.delete": { "post": { "summary": "Remove users from group sonet_group.user.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.delete` removes participants from a workgroup or project.", "operationId": "user_delete", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| Identifier of the participant." } }, "required": [ "GROUP_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| Identifier of the participant." } }, "required": [ "GROUP_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.fields": { "post": { "summary": "Get User Fields user.fields", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `user.fields` method allows you to retrieve a list of user field names. The method returns a standard list of fields, and the use of custom fields is not supported. The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application's/webhook's scope. Details about accessing user data can be found in the [article](index.md). Without parameters.", "operationId": "user_fields", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/user-fields.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing user fields ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response containing user fields ||" }, "time": { "type": "string", "description": "| Information about the request execution time ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.get": { "post": { "summary": "Get the list of group participants sonet_group.user.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.get` returns a list of active participants in a workgroup or project.", "operationId": "user_get", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the workgroup or project." } }, "required": [ "ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ID": { "type": "integer", "description": "| Identifier of the workgroup or project." } }, "required": [ "ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.groups": { "post": { "summary": "Get the list of groups for the current user sonet_group.user.groups", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.groups` returns the groups and projects that the current user is a member of.", "operationId": "user_groups", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/sonet-group-user-groups.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.invite": { "post": { "summary": "Invite users to group sonet_group.user.invite", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.invite` sends invitations to users in a workgroup or project.", "operationId": "user_invite", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-invite.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| User identifier." }, "MESSAGE": { "type": "string", "description": "| Invitation text. ||" } }, "required": [ "GROUP_ID", "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| User identifier." }, "MESSAGE": { "type": "string", "description": "| Invitation text. ||" } }, "required": [ "GROUP_ID", "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.option": { "post": { "summary": "Get data associated with the application and user user.option.*", "description": "Some data may be missing — we will complete it soon. - missing parameters or fields - parameter types not specified - required parameters not specified", "operationId": "user_option", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/settings/user-option.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/user.option.get": { "post": { "summary": "Get User Data Associated with the Application user.option.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.option.get` retrieves user data associated with the application. If no input is provided, it will return all properties recorded through [user.option.set](./user-option-set.md).", "operationId": "user_option_get", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/settings/user-option-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| A string, one of the keys from the property user.option.set. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "option": { "type": "string", "description": "| A string, one of the keys from the property user.option.set. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/user.option.set": { "post": { "summary": "Bind Data to User and Application user.option.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.option.set` binds data to the application and user. The application can be bound to the user who installed it if it is a [headless application](../../../local-integrations/serverside-local-app-with-no-ui.md) or to the user with whom it interacts if it is a [UI application](../../../local-integrations/serverside-local-app-with-ui.md).", "operationId": "user_option_set", "tags": [ "General Methods" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/common/settings/user-option-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "array", "items": {}, "description": "| An array where the key is the name of the property to be saved, and the value is the property value. If a value with a new key is passed, the method will write it; if an existing one, it will update it. ||" } }, "required": [ "options" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "options": { "type": "array", "items": {}, "description": "| An array where the key is the name of the property to be saved, and the value is the property value. If a value with a new key is passed, the method will write it; if an existing one, it will update it. ||" } }, "required": [ "options" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "basic" ] } ] } }, "/user.request": { "post": { "summary": "Send a request to join the group sonet_group.user.request", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.request` sends a request from the current user to join a workgroup or project.", "operationId": "user_request", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-request.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "MESSAGE": { "type": "string", "description": "| Text of the request to join. ||" } }, "required": [ "GROUP_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "MESSAGE": { "type": "string", "description": "| Text of the request to join. ||" } }, "required": [ "GROUP_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.search": { "post": { "summary": "Get a List of Users with Search by Personal Data user.search", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `user.search` method allows you to retrieve a list of users with accelerated search based on personal data (first name, last name, patronymic, department name, job title). It operates in two modes: quickly using **Fulltext Index** and a slower option through [right LIKE](*key_right LIKE) (support is determined automatically). The list of user fields in Bitrix24 that will be returned as a result of executing the method depends on the application's/webhook's scope. Details about accessing user data can be found in the [article](index.md). The method inherits the behavior of the [user.get](./user-get.md) method, and all parameters from this function are also available.", "operationId": "user_search", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/user-search.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "string", "description": "| The array can contain fields in any combination:" }, "sort": { "type": "string", "description": "| The field by which the results are sorted. Sorting works on all fields from user.add ||" }, "order": { "type": "string", "description": "| Sorting direction:" }, "ADMIN_MODE": { "type": "boolean", "description": "| Key for operation in administrator mode. Used to retrieve data about any users ||" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "string", "description": "| The array can contain fields in any combination:" }, "sort": { "type": "string", "description": "| The field by which the results are sorted. Sorting works on all fields from user.add ||" }, "order": { "type": "string", "description": "| Sorting direction:" }, "ADMIN_MODE": { "type": "boolean", "description": "| Key for operation in administrator mode. Used to retrieve data about any users ||" }, "start": { "type": "integer", "description": "| This parameter is used for managing pagination." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user" ] } ] } }, "/user.update": { "post": { "summary": "Change Role of Group Participants sonet_group.user.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `sonet_group.user.update` changes the role of participants in a workgroup or project. To change the owner, use the method [sonet_group.setowner](../sonet-group-setowner.md)", "operationId": "user_update", "tags": [ "Workgroups" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/sonet-group/members/sonet-group-user-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| Identifier of the participant." }, "ROLE": { "type": "string", "description": "| Code of the new participant role." } }, "required": [ "GROUP_ID", "USER_ID", "ROLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "GROUP_ID": { "type": "integer", "description": "| Identifier of the workgroup or project." }, "USER_ID": { "type": "string", "description": "| Identifier of the participant." }, "ROLE": { "type": "string", "description": "| Code of the new participant role." } }, "required": [ "GROUP_ID", "USER_ID", "ROLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "sonet" ] } ] } }, "/user.userfield.add": { "post": { "summary": "Add Custom Field user.userfield.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.userfield.add` adds a custom field.", "operationId": "user_userfield_add", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/userfields/user-userfield-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Values of the fields to add a new custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Name (code) of the field. Prefixed with `UF_USR_`" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sorting order ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the custom field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the field in the list. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for custom fields. Settings are described below ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Column header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message for invalid input. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help text for the field. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LABEL": { "type": "string", "description": "| Default name of the custom field." } }, "required": [ "fields", "FIELD_NAME", "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "| Values of the fields to add a new custom field ||" }, "FIELD_NAME": { "type": "string", "description": "| Name (code) of the field. Prefixed with `UF_USR_`" }, "USER_TYPE_ID": { "type": "string", "description": "| Type of the custom field. Possible values:" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sorting order ||" }, "MULTIPLE": { "type": "boolean", "description": "| Is the field multiple. Possible values:" }, "MANDATORY": { "type": "boolean", "description": "| Is the custom field mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Show the field in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Show the field in the list. Possible values:" }, "SETTINGS": { "type": "object", "description": "| Object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for custom fields. Settings are described below ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Column header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message for invalid input. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help text for the field. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LABEL": { "type": "string", "description": "| Default name of the custom field." } }, "required": [ "fields", "FIELD_NAME", "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.delete": { "post": { "summary": "Delete User Field user.userfield.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.userfield.delete` removes a user field.", "operationId": "user_userfield_delete", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/userfields/user-userfield-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.file.get": { "post": { "summary": "Get File from User Field user.userfield.file.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The page is hidden from the menu, and the method is not operational. Some data may be missing here — we will complete it shortly. - It may be necessary to list parameters or fields in a table.", "operationId": "user_userfield_file_get", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/userfields/user-userfield-file-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.list": { "post": { "summary": "Get a list of custom fields user.userfield.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.userfield.list` retrieves a list of custom fields based on the filter.", "operationId": "user_userfield_list", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/userfields/user-userfield-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "\\|`array` | Sorting of the selected custom fields in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Filter for the selected custom fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "order": { "type": "string", "description": "\\|`array` | Sorting of the selected custom fields in the format `{\"field_1\": \"order_1\", ... \"field_N\": \"order_N\"}`." }, "filter": { "type": "array", "items": {}, "description": "| Filter for the selected custom fields in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/user.userfield.update": { "post": { "summary": "Update User Field user.userfield.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `user.userfield.update` updates a user field.", "operationId": "user_userfield_update", "tags": [ "Users" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user/userfields/user-userfield-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." }, "fields": { "type": "object", "description": "| Values of the fields to update the user field ||" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort order ||" }, "MANDATORY": { "type": "boolean", "description": "| Whether the user field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Whether to show the field in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show the field in the list. Possible values:" }, "SETTINGS": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for user fields. Settings are described below ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Column header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message for invalid input. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help text for the field. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LABEL": { "type": "string", "description": "| Default name of the user field." } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the user field." }, "fields": { "type": "object", "description": "| Values of the fields to update the user field ||" }, "XML_ID": { "type": "string", "description": "| External code ||" }, "SORT": { "type": "integer", "description": "| Sort order ||" }, "MANDATORY": { "type": "boolean", "description": "| Whether the user field is mandatory. Possible values:" }, "SHOW_FILTER": { "type": "boolean", "description": "| Whether to show the field in the list filter. Possible values:" }, "SHOW_IN_LIST": { "type": "boolean", "description": "| Whether to show the field in the list. Possible values:" }, "SETTINGS": { "type": "object", "description": "| An object in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}` for passing additional settings for user fields. Settings are described below ||" }, "EDIT_FORM_LABEL": { "type": "string", "description": "| Label in the edit form. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_COLUMN_LABEL": { "type": "string", "description": "| Column header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LIST_FILTER_LABEL": { "type": "string", "description": "| Filter header in the list. You can pass a string or an object with labels by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "ERROR_MESSAGE": { "type": "string", "description": "| Error message for invalid input. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "HELP_MESSAGE": { "type": "string", "description": "| Help text for the field. You can pass a string or an object with texts by languages in the format `{\"de\": \"...\", \"en\": \"...\"}`. When passing a string, the value will be set for all languages ||" }, "LABEL": { "type": "string", "description": "| Default name of the user field." } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "user.userfield" ] } ] } }, "/userconsent.agreement.list": { "post": { "summary": "Get the list of agreements userconsent.agreement.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userconsent.agreement.list` returns a list of agreements.", "operationId": "userconsent_agreement_list", "tags": [ "User Consent" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user-consent/user-consent-agreement-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userconsent.agreement.text": { "post": { "summary": "Get the text of the agreement userconsent.agreement.text", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userconsent.agreement.text` returns the text of the agreement.", "operationId": "userconsent_agreement_text", "tags": [ "User Consent" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user-consent/user-consent-agreement-text.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the agreement." }, "replace": { "type": "object", "description": "| Array of replacements for text substitution. Available keys:" } }, "required": [ "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "| Identifier of the agreement." }, "replace": { "type": "object", "description": "| Array of replacements for text substitution. Available keys:" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userconsent.consent.add": { "post": { "summary": "Save the User Consent userconsent.consent.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userconsent.consent.add` saves the user's consent.", "operationId": "userconsent_consent_add", "tags": [ "User Consent" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/user-consent/user-consent-consent-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "AGREEMENT_ID": { "type": "integer", "description": "| Agreement identifier." }, "IP": { "type": "string", "description": "| User's IP address ||" }, "USER_ID": { "type": "integer", "description": "| User identifier." }, "URL": { "type": "string", "description": "| URL of the page where consent was obtained ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the source, for example, `my_contact_form` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the element in the source, for example, e-mail ||" } }, "required": [ "AGREEMENT_ID", "IP" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "AGREEMENT_ID": { "type": "integer", "description": "| Agreement identifier." }, "IP": { "type": "string", "description": "| User's IP address ||" }, "USER_ID": { "type": "integer", "description": "| User identifier." }, "URL": { "type": "string", "description": "| URL of the page where consent was obtained ||" }, "ORIGIN_ID": { "type": "string", "description": "| Identifier of the source, for example, `my_contact_form` ||" }, "ORIGINATOR_ID": { "type": "string", "description": "| Identifier of the element in the source, for example, e-mail ||" } }, "required": [ "AGREEMENT_ID", "IP" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userconsent" ] } ] } }, "/userfieldconfig.add": { "post": { "summary": "Add Custom Field userfieldconfig.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `userfieldconfig.add` method adds a new custom field.", "operationId": "userfieldconfig_add", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Module identifier where the field is created ||" }, "field": { "type": "object", "description": "| Object with custom field settings (detailed description) ||" }, "entityId": { "type": "string", "description": "| Identifier of the object for which the field is created. The format depends on the module, for example, `CRM_7` for SPA ||" }, "fieldName": { "type": "string", "description": "| Field code in the format `UF_{OBJECT_IDENTIFIER}_{POSTFIX}`. The code must be unique within the object. Allowed characters are `A-Z`, `0-9`, `_`. Maximum length of the code is 50 characters ||" }, "userTypeId": { "type": "string", "description": "| Identifier of the field type. The list of available types is returned by the userfieldconfig.getTypes method ||" }, "xmlId": { "type": "string", "description": "| External identifier of the field ||" }, "sort": { "type": "integer", "description": "| Sort index. Default is `100` ||" }, "multiple": { "type": "boolean", "description": "| Whether the field is multiple. Possible values: `Y` or `N`. Default is `N` ||" }, "mandatory": { "type": "boolean", "description": "| Whether the field is mandatory. Possible values: `Y` or `N`. Default is `N` ||" }, "showFilter": { "type": "boolean", "description": "| Whether to show the field in the filter. Possible values: `Y` or `N`. Default is `N` ||" }, "editInList": { "type": "boolean", "description": "| Whether to allow editing the value in the list. Possible values: `Y` or `N` ||" }, "isSearchable": { "type": "boolean", "description": "| Whether the field values participate in the search. Possible values: `Y` or `N` ||" }, "settings": { "type": "object", "description": "| Additional field settings. The set of keys depends on `userTypeId` (detailed description) ||" }, "editFormLabel": { "type": "string", "description": "\\|`lang_map` | Label in the edit form. When a string is passed, it is used as a general value; when a `lang_map` is passed, labels can be set by languages ||" }, "helpMessage": { "type": "string", "description": "\\|`lang_map` | Help text. When a string is passed, it is used as a general value; when a `lang_map` is passed, help texts can be set by languages ||" }, "enum": { "type": "string", "description": "| Value options for fields of type `enumeration` ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the CRM reference type. Possible values can be obtained using the `crm.status.entity.types` method ||" }, "value": { "type": "string", "description": "| Value of the list option ||" }, "def": { "type": "boolean", "description": "| Default value flag (`Y`/`N`) ||" } }, "required": [ "moduleId", "field", "entityId", "fieldName", "userTypeId", "value" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Module identifier where the field is created ||" }, "field": { "type": "object", "description": "| Object with custom field settings (detailed description) ||" }, "entityId": { "type": "string", "description": "| Identifier of the object for which the field is created. The format depends on the module, for example, `CRM_7` for SPA ||" }, "fieldName": { "type": "string", "description": "| Field code in the format `UF_{OBJECT_IDENTIFIER}_{POSTFIX}`. The code must be unique within the object. Allowed characters are `A-Z`, `0-9`, `_`. Maximum length of the code is 50 characters ||" }, "userTypeId": { "type": "string", "description": "| Identifier of the field type. The list of available types is returned by the userfieldconfig.getTypes method ||" }, "xmlId": { "type": "string", "description": "| External identifier of the field ||" }, "sort": { "type": "integer", "description": "| Sort index. Default is `100` ||" }, "multiple": { "type": "boolean", "description": "| Whether the field is multiple. Possible values: `Y` or `N`. Default is `N` ||" }, "mandatory": { "type": "boolean", "description": "| Whether the field is mandatory. Possible values: `Y` or `N`. Default is `N` ||" }, "showFilter": { "type": "boolean", "description": "| Whether to show the field in the filter. Possible values: `Y` or `N`. Default is `N` ||" }, "editInList": { "type": "boolean", "description": "| Whether to allow editing the value in the list. Possible values: `Y` or `N` ||" }, "isSearchable": { "type": "boolean", "description": "| Whether the field values participate in the search. Possible values: `Y` or `N` ||" }, "settings": { "type": "object", "description": "| Additional field settings. The set of keys depends on `userTypeId` (detailed description) ||" }, "editFormLabel": { "type": "string", "description": "\\|`lang_map` | Label in the edit form. When a string is passed, it is used as a general value; when a `lang_map` is passed, labels can be set by languages ||" }, "helpMessage": { "type": "string", "description": "\\|`lang_map` | Help text. When a string is passed, it is used as a general value; when a `lang_map` is passed, help texts can be set by languages ||" }, "enum": { "type": "string", "description": "| Value options for fields of type `enumeration` ||" }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the CRM reference type. Possible values can be obtained using the `crm.status.entity.types` method ||" }, "value": { "type": "string", "description": "| Value of the list option ||" }, "def": { "type": "boolean", "description": "| Default value flag (`Y`/`N`) ||" } }, "required": [ "moduleId", "field", "entityId", "fieldName", "userTypeId", "value" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.delete": { "post": { "summary": "Delete User Field userfieldconfig.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `userfieldconfig.delete` method removes a user field.", "operationId": "userfieldconfig_delete", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module from which the field is being deleted ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings." } }, "required": [ "moduleId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module from which the field is being deleted ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings." } }, "required": [ "moduleId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.get": { "post": { "summary": "Get User Field Settings userfieldconfig.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `userfieldconfig.get` method returns the settings of a user field by its identifier.", "operationId": "userfieldconfig_get", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module where the field is located ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings." } }, "required": [ "moduleId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module where the field is located ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings." } }, "required": [ "moduleId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.getTypes": { "post": { "summary": "Get Available User Field Types userfieldconfig.getTypes", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. The method `userfieldconfig.getTypes` returns a set of available user field types for the module.", "operationId": "userfieldconfig_getTypes", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-get-types.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module for which to retrieve available field types ||" } }, "required": [ "moduleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module for which to retrieve available field types ||" } }, "required": [ "moduleId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.list": { "post": { "summary": "Get a List of User Field Settings userfieldconfig.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userfieldconfig.list` returns a list of user field settings based on the filter.", "operationId": "userfieldconfig_list", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| The identifier of the module in which the fields are being searched ||" }, "select": { "type": "object", "description": "| Set of fields to return (detailed description) ||" }, "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Offset for pagination." }, "language": { "type": "string", "description": "| Language identifier for language fields, for example `de` or `en` ||" }, "id": { "type": "string", "description": "| Identifier of the field setting ||" }, "entityId": { "type": "string", "description": "| Identifier of the object ||" }, "fieldName": { "type": "string", "description": "| Code of the field ||" }, "userTypeId": { "type": "string", "description": "| Type of the field ||" }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "sort": { "type": "string", "description": "| Sort index ||" }, "multiple": { "type": "string", "description": "| Whether the user field is multiple. Possible values: `Y` or `N` ||" }, "mandatory": { "type": "string", "description": "| Whether the user field is mandatory. Possible values: `Y` or `N` ||" }, "showFilter": { "type": "string", "description": "| Whether to show the field in the list filter. Possible values: `N`, `I`, `E`, `S` ||" }, "showInList": { "type": "string", "description": "| Whether to show the field in the list. Possible values: `Y` or `N` ||" }, "editInList": { "type": "string", "description": "| Whether to allow editing the value in the list. Possible values: `Y` or `N` ||" }, "isSearchable": { "type": "string", "description": "| Whether the field values are searchable. Possible values: `Y` or `N` ||" }, "settings": { "type": "string", "description": "| Additional settings for the field ||" }, "languageId": { "type": "string", "description": "| Language identifier. When this parameter is passed, a set of language fields in the selected language is returned:" } }, "required": [ "moduleId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| The identifier of the module in which the fields are being searched ||" }, "select": { "type": "object", "description": "| Set of fields to return (detailed description) ||" }, "order": { "type": "object", "description": "| Object format:" }, "filter": { "type": "object", "description": "| Object format:" }, "start": { "type": "integer", "description": "| Offset for pagination." }, "language": { "type": "string", "description": "| Language identifier for language fields, for example `de` or `en` ||" }, "id": { "type": "string", "description": "| Identifier of the field setting ||" }, "entityId": { "type": "string", "description": "| Identifier of the object ||" }, "fieldName": { "type": "string", "description": "| Code of the field ||" }, "userTypeId": { "type": "string", "description": "| Type of the field ||" }, "xmlId": { "type": "string", "description": "| External identifier ||" }, "sort": { "type": "string", "description": "| Sort index ||" }, "multiple": { "type": "string", "description": "| Whether the user field is multiple. Possible values: `Y` or `N` ||" }, "mandatory": { "type": "string", "description": "| Whether the user field is mandatory. Possible values: `Y` or `N` ||" }, "showFilter": { "type": "string", "description": "| Whether to show the field in the list filter. Possible values: `N`, `I`, `E`, `S` ||" }, "showInList": { "type": "string", "description": "| Whether to show the field in the list. Possible values: `Y` or `N` ||" }, "editInList": { "type": "string", "description": "| Whether to allow editing the value in the list. Possible values: `Y` or `N` ||" }, "isSearchable": { "type": "string", "description": "| Whether the field values are searchable. Possible values: `Y` or `N` ||" }, "settings": { "type": "string", "description": "| Additional settings for the field ||" }, "languageId": { "type": "string", "description": "| Language identifier. When this parameter is passed, a set of language fields in the selected language is returned:" } }, "required": [ "moduleId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldconfig.update": { "post": { "summary": "Update User Field userfieldconfig.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `userfieldconfig.update` method updates the settings of an existing user field.", "operationId": "userfieldconfig_update", "tags": [ "CRM" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/crm/universal/userfieldconfig/userfieldconfig-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module where the field is located ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings ||" }, "field": { "type": "object", "description": "| Object with new field settings (detailed description) ||" }, "xmlId": { "type": "string", "description": "| External identifier of the field ||" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "mandatory": { "type": "boolean", "description": "| Mandatory field flag (`Y`/`N`) ||" }, "showFilter": { "type": "boolean", "description": "| Show field in filter flag (`Y`/`N`) ||" }, "isSearchable": { "type": "boolean", "description": "| Field participation in search flag (`Y`/`N`) ||" }, "editFormLabel": { "type": "string", "description": "| Labels in the edit form by languages ||" }, "helpMessage": { "type": "string", "description": "| Help text by languages ||" }, "settings": { "type": "object", "description": "| Additional field settings. The set of keys depends on the field type (detailed description) ||" }, "enum": { "type": "string", "description": "| List of value options for the `enumeration` field type." }, "userTypeId": { "type": "string", "description": "| Field type." }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the CRM reference type. Possible values can be obtained using the method `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Value of the option ||" }, "def": { "type": "boolean", "description": "| Default value flag (`Y`/`N`) ||" }, "del": { "type": "boolean", "description": "| Flag for deleting the existing option (`Y`/`N`) ||" } }, "required": [ "moduleId", "id" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Identifier of the module where the field is located ||" }, "id": { "type": "integer", "description": "| Identifier of the user field settings ||" }, "field": { "type": "object", "description": "| Object with new field settings (detailed description) ||" }, "xmlId": { "type": "string", "description": "| External identifier of the field ||" }, "sort": { "type": "integer", "description": "| Sort index ||" }, "mandatory": { "type": "boolean", "description": "| Mandatory field flag (`Y`/`N`) ||" }, "showFilter": { "type": "boolean", "description": "| Show field in filter flag (`Y`/`N`) ||" }, "isSearchable": { "type": "boolean", "description": "| Field participation in search flag (`Y`/`N`) ||" }, "editFormLabel": { "type": "string", "description": "| Labels in the edit form by languages ||" }, "helpMessage": { "type": "string", "description": "| Help text by languages ||" }, "settings": { "type": "object", "description": "| Additional field settings. The set of keys depends on the field type (detailed description) ||" }, "enum": { "type": "string", "description": "| List of value options for the `enumeration` field type." }, "userTypeId": { "type": "string", "description": "| Field type." }, "ENTITY_TYPE": { "type": "string", "description": "| Identifier of the CRM reference type. Possible values can be obtained using the method `crm.status.entity.types` ||" }, "value": { "type": "string", "description": "| Value of the option ||" }, "def": { "type": "boolean", "description": "| Default value flag (`Y`/`N`) ||" }, "del": { "type": "boolean", "description": "| Flag for deleting the existing option (`Y`/`N`) ||" } }, "required": [ "moduleId", "id" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "userfieldconfig" ] } ] } }, "/userfieldtype.add": { "post": { "summary": "Register a New User Field Type userfieldtype.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userfieldtype.add` registers a new type of user fields. After registering the type, create a user field using the [userfieldconfig.add](../../crm/universal/userfieldconfig/userfieldconfig-add.md) method. When opening a card with a user type field, an array `PLACEMENT_OPTIONS` containing data about the field and entity is passed to the application handler.", "operationId": "userfieldtype_add", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/user-field/userfieldtype-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" }, "HANDLER": { "type": "string", "description": "| Address of the user type handler |" }, "TITLE": { "type": "string", "description": "| Text title of the type. Will be displayed in the administrative interface for user field settings | ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the type. Will be displayed in the administrative interface for user field settings | ||" }, "OPTIONS": { "type": "array", "items": {}, "description": "| Additional settings. Currently, one key is available: `height` — specifies the height of the user field in pixels. Any positive value will apply." } }, "required": [ "USER_TYPE_ID", "HANDLER" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" }, "HANDLER": { "type": "string", "description": "| Address of the user type handler |" }, "TITLE": { "type": "string", "description": "| Text title of the type. Will be displayed in the administrative interface for user field settings | ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the type. Will be displayed in the administrative interface for user field settings | ||" }, "OPTIONS": { "type": "array", "items": {}, "description": "| Additional settings. Currently, one key is available: `height` — specifies the height of the user field in pixels. Any positive value will apply." } }, "required": [ "USER_TYPE_ID", "HANDLER" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "depending on the placement" ] } ] } }, "/userfieldtype.delete": { "post": { "summary": "Delete Registered User Field Type userfieldtype.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userfieldtype.delete` removes a user field type registered by the application. It returns _true_ or an error with a description of the reason.", "operationId": "userfieldtype_delete", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/user-field/userfieldtype-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" } }, "required": [ "USER_TYPE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" } }, "required": [ "USER_TYPE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "depending on the integration point" ] } ] } }, "/userfieldtype.list": { "post": { "summary": "Get a list of registered user field types userfieldtype.list", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method retrieves a list of user field types registered by the application. It returns a list of field types with pagination. No parameters.", "operationId": "userfieldtype_list", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/user-field/userfieldtype-list.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "total": { "type": "integer", "description": "| Number of processed records ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "result": { "type": "object", "description": "| Root element of the response ||" }, "total": { "type": "integer", "description": "| Number of processed records ||" }, "time": { "type": "string", "description": "| Information about the execution time of the request ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "depending on the embedding location" ] } ] } }, "/userfieldtype.update": { "post": { "summary": "Change settings for user field type userfieldtype.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `userfieldtype.update` modifies the settings of a user field type registered by the application. It returns _true_ or an error with a description of the reason.", "operationId": "userfieldtype_update", "tags": [ "Widgets" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/widgets/user-field/userfieldtype-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" }, "HANDLER": { "type": "string", "description": "| Address of the user type handler |" }, "TITLE": { "type": "string", "description": "| Text name of the type. Will be displayed in the administrative interface for user field settings | ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the type. Will be displayed in the administrative interface for user field settings | ||" }, "OPTIONS": { "type": "array", "items": {}, "description": "| Additional settings. Currently, one key is available: `height` — specifies the height of the user field in pixels. Any positive value will apply." } }, "required": [ "USER_TYPE_ID", "HANDLER", "TITLE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_TYPE_ID": { "type": "string", "description": "| String code of the type |" }, "HANDLER": { "type": "string", "description": "| Address of the user type handler |" }, "TITLE": { "type": "string", "description": "| Text name of the type. Will be displayed in the administrative interface for user field settings | ||" }, "DESCRIPTION": { "type": "string", "description": "| Text description of the type. Will be displayed in the administrative interface for user field settings | ||" }, "OPTIONS": { "type": "array", "items": {}, "description": "| Additional settings. Currently, one key is available: `height` — specifies the height of the user field in pixels. Any positive value will apply." } }, "required": [ "USER_TYPE_ID", "HANDLER", "TITLE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "depending on the embedding location" ] } ] } }, "/vote.AttachedVote.download": { "post": { "summary": "Download the voting report vote.AttachedVote.download", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.download` generates and provides a downloadable report for the vote in the specified format. Attention! This method is an exception to the general rule of working with the REST API. Unlike other methods, it returns not a `JSON` object, but the actual content of the file with HTTP headers that initiate the download in the browser. Due to this, the standard function `BX24.callMethod()` **cannot** process the response and will throw an error. To work with this method, a direct HTTP request must be made, as shown in the JS code example.", "operationId": "vote_AttachedVote_download", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.download.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.get": { "post": { "summary": "Get Data of Attached Vote vote.AttachedVote.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.get` returns data of the attached vote.", "operationId": "vote_AttachedVote_get", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| ID of the attached vote, can be equal to `voteId` from the results of vote.Integration.Im.send ||" }, "moduleId": { "type": "string", "description": "| Module ID, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| Signed attachment ID, can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| ID of the attached vote, can be equal to `voteId` from the results of vote.Integration.Im.send ||" }, "moduleId": { "type": "string", "description": "| Module ID, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| Signed attachment ID, can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getAnswerVoted": { "post": { "summary": "Get the list of users who voted for the answer vote.AttachedVote.getAnswerVoted", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.getAnswerVoted` returns a list of users who voted for the specified answer option.", "operationId": "vote_AttachedVote_getAnswerVoted", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.getAnswerVoted.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "answerId": { "type": "integer", "description": "| The ID of the answer, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "pageNavigation": { "type": "object", "description": "| Pagination parameters, for example { size: 10, page: 1 } ||" }, "userForMobileFormat": { "type": "boolean", "description": "| User data format for mobile devices. Default value: `false` ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the element, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "answerId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "answerId": { "type": "integer", "description": "| The ID of the answer, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "pageNavigation": { "type": "object", "description": "| Pagination parameters, for example { size: 10, page: 1 } ||" }, "userForMobileFormat": { "type": "boolean", "description": "| User data format for mobile devices. Default value: `false` ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the element, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "answerId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getMany": { "post": { "summary": "Get Multiple Votes vote.AttachedVote.getMany", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.getMany` returns data for multiple votes based on the identifiers of the entities to which the vote is attached.", "operationId": "vote_AttachedVote_getMany", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.getMany.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Module identifier, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Array of entity identifiers, possible values:" } }, "required": [ "moduleId", "entityType", "entityId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "moduleId": { "type": "string", "description": "| Module identifier, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Array of entity identifiers, possible values:" } }, "required": [ "moduleId", "entityType", "entityId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.getWithVoted": { "post": { "summary": "Get Voting Data with Voter Information vote.AttachedVote.getWithVoted", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.getWithVoted` returns data for the attached vote along with information about the users who voted.", "operationId": "vote_AttachedVote_getWithVoted", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.getWithVoted.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "pageSize": { "type": "integer", "description": "| The number of records per page for the list of voters." }, "userForMobileFormat": { "type": "boolean", "description": "| User data format for mobile devices." }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "pageSize": { "type": "integer", "description": "| The number of records per page for the list of voters." }, "userForMobileFormat": { "type": "boolean", "description": "| User data format for mobile devices." }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.recall": { "post": { "summary": "Recall Your Vote vote.AttachedVote.recall", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.recall` allows a user to withdraw their vote in an active voting session. This method only works with votes where the option Allow Re-voting is enabled.", "operationId": "vote_AttachedVote_recall", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.recall.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed attachment ID, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed attachment ID, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.resume": { "post": { "summary": "Resume Voting vote.AttachedVote.resume", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.resume` resumes a stopped vote, allowing users to participate in it again.", "operationId": "vote_AttachedVote_resume", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.resume.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed ID of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.stop": { "post": { "summary": "Stop voting vote.AttachedVote.stop", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.stop` halts an active vote, preventing further participation.", "operationId": "vote_AttachedVote_stop", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.stop.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed attachment ID, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "moduleId": { "type": "string", "description": "| The module ID, possible values:" }, "entityType": { "type": "string", "description": "| The object type, possible values:" }, "entityId": { "type": "integer", "description": "| The ID of the entity, possible values:" }, "signedAttachId": { "type": "string", "description": "| The signed attachment ID, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.AttachedVote.vote": { "post": { "summary": "Vote in the attached voting vote.AttachedVote.vote", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.AttachedVote.vote` allows you to vote in an attached voting.", "operationId": "vote_AttachedVote_vote", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.attachedvote.vote.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached voting, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "ballot": { "type": "object", "description": "| Voting data in the format:" }, "moduleId": { "type": "string", "description": "| Module ID, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| Signed identifier of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "ballot", "moduleId", "entityType", "entityId", "signedAttachId" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "attachId": { "type": "integer", "description": "| The ID of the attached voting, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany ||" }, "ballot": { "type": "object", "description": "| Voting data in the format:" }, "moduleId": { "type": "string", "description": "| Module ID, possible values:" }, "entityType": { "type": "string", "description": "| Object type, possible values:" }, "entityId": { "type": "integer", "description": "| Element ID, possible values:" }, "signedAttachId": { "type": "string", "description": "| Signed identifier of the attachment, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId` ||" } }, "required": [ "attachId", "ballot", "moduleId", "entityType", "entityId", "signedAttachId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/vote.Integration.Im.send": { "post": { "summary": "Create and Send a Vote in Chat vote.Integration.Im.send", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `vote.Integration.Im.send` creates and sends a vote to the specified chat in the messenger.", "operationId": "vote_Integration_Im_send", "tags": [ "Polls" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/vote/vote.integration.im.send.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "integer", "description": "| The identifier of the chat to which the vote is sent. It can be obtained using the methods im.chat.add, im.chat.get, im.recent.get, im.recent.list ||" }, "IM_MESSAGE_VOTE_DATA": { "type": "object", "description": "| Vote data containing the question and answer options. The structure is described below ||" }, "templateId": { "type": "string", "description": "| A unique identifier for the request, with no format requirements. The purpose of the identifier is to prevent duplication. If the request is sent again due to a network failure with the same `templateId`, the server will recognize this and create the vote only once ||" }, "QUESTIONS": { "type": "array", "items": {}, "description": "| An array of vote questions, the structure is described below. Maximum 1 question ||" }, "ANONYMITY": { "type": "integer", "description": "| Anonymity of the vote. Possible values:" }, "OPTIONS": { "type": "integer", "description": "| Allow re-voting. Possible values:" }, "QUESTION": { "type": "string", "description": "| The text of the question ||" }, "FIELD_TYPE": { "type": "integer", "description": "| The type of field for the answer. Possible values:" }, "ANSWERS": { "type": "array", "items": {}, "description": "| An array of answer options, the structure is described below. Minimum 2 options, maximum 10 ||" }, "MESSAGE": { "type": "string", "description": "| The text of the answer option ||" } }, "required": [ "chatId", "IM_MESSAGE_VOTE_DATA", "QUESTIONS" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "chatId": { "type": "integer", "description": "| The identifier of the chat to which the vote is sent. It can be obtained using the methods im.chat.add, im.chat.get, im.recent.get, im.recent.list ||" }, "IM_MESSAGE_VOTE_DATA": { "type": "object", "description": "| Vote data containing the question and answer options. The structure is described below ||" }, "templateId": { "type": "string", "description": "| A unique identifier for the request, with no format requirements. The purpose of the identifier is to prevent duplication. If the request is sent again due to a network failure with the same `templateId`, the server will recognize this and create the vote only once ||" }, "QUESTIONS": { "type": "array", "items": {}, "description": "| An array of vote questions, the structure is described below. Maximum 1 question ||" }, "ANONYMITY": { "type": "integer", "description": "| Anonymity of the vote. Possible values:" }, "OPTIONS": { "type": "integer", "description": "| Allow re-voting. Possible values:" }, "QUESTION": { "type": "string", "description": "| The text of the question ||" }, "FIELD_TYPE": { "type": "integer", "description": "| The type of field for the answer. Possible values:" }, "ANSWERS": { "type": "array", "items": {}, "description": "| An array of answer options, the structure is described below. Minimum 2 options, maximum 10 ||" }, "MESSAGE": { "type": "string", "description": "| The text of the answer option ||" } }, "required": [ "chatId", "IM_MESSAGE_VOTE_DATA", "QUESTIONS" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "vote" ] } ] } }, "/voximplant.callback.start": { "post": { "summary": "Start a Callback with voximplant.callback.start", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.callback.start` initiates a callback between an employee and a client.", "operationId": "voximplant_callback_start", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-callback-start.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the callback is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The client's number to call. ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| The text that the system will pronounce to the employee before connecting with the client. ||" }, "VOICE": { "type": "string", "description": "| Identifier of the voice for speech synthesis." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the callback is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The client's number to call. ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| The text that the system will pronounce to the employee before connecting with the client. ||" }, "VOICE": { "type": "string", "description": "| Identifier of the voice for speech synthesis." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.infocall.startwithsound": { "post": { "summary": "Make an Auto-Call with MP3 Playback using voximplant.infocall.startwithsound", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.infocall.startwithsound` initiates an auto-call and plays an MP3 file from a URL.", "operationId": "voximplant_infocall_startwithsound", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-infocall-start-with-sound.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the call is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The number to which the call should be made. ||" }, "URL": { "type": "string", "description": "| Link to the MP3 file that should be played during the call. ||" } }, "required": [ "FROM_LINE", "TO_NUMBER", "URL" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the call is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The number to which the call should be made. ||" }, "URL": { "type": "string", "description": "| Link to the MP3 file that should be played during the call. ||" } }, "required": [ "FROM_LINE", "TO_NUMBER", "URL" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.infocall.startwithtext": { "post": { "summary": "Initiate an Auto-Call with the Voice Automation Rule voximplant.infocall.startwithtext", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.infocall.startwithtext` initiates an auto-call and plays the specified text to the recipient using speech synthesis.", "operationId": "voximplant_infocall_startwithtext", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-infocall-start-with-text.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the call is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The number to which the call should be made. ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| The text that will be spoken to the recipient. ||" }, "VOICE": { "type": "string", "description": "| Identifier of the voice for speech synthesis." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FROM_LINE": { "type": "string", "description": "| Identifier of the outgoing line from which the call is initiated." }, "TO_NUMBER": { "type": "string", "description": "| The number to which the call should be made. ||" }, "TEXT_TO_PRONOUNCE": { "type": "string", "description": "| The text that will be spoken to the recipient. ||" }, "VOICE": { "type": "string", "description": "| Identifier of the voice for speech synthesis." } }, "required": [ "FROM_LINE", "TO_NUMBER", "TEXT_TO_PRONOUNCE" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.get": { "post": { "summary": "Get a List of Outgoing Lines voximplant.line.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.get` returns a list of available outgoing lines.", "operationId": "voximplant_line_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/lines/voximplant-line-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.get": { "post": { "summary": "Get Line for Outgoing Calls voximplant.line.outgoing.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.get` returns the identifier of the current default outgoing line.", "operationId": "voximplant_line_outgoing_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.set": { "post": { "summary": "Set Outgoing Line voximplant.line.outgoing.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.set` sets the default outgoing line.", "operationId": "voximplant_line_outgoing_set", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "LINE_ID": { "type": "string", "description": "| Line identifier." } }, "required": [ "LINE_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "LINE_ID": { "type": "string", "description": "| Line identifier." } }, "required": [ "LINE_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.line.outgoing.sip.set": { "post": { "summary": "Set Outgoing SIP Line voximplant.line.outgoing.sip.set", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.line.outgoing.sip.set` sets the SIP line as the default outgoing line.", "operationId": "voximplant_line_outgoing_sip_set", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/lines/voximplant-line-outgoing-sip-set.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.add": { "post": { "summary": "Create SIP Line voximplant.sip.add", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.add` creates a new SIP line associated with an application.", "operationId": "voximplant_sip_add", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-add.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "SERVER": { "type": "string", "description": "| Address of the SIP registration server ||" }, "LOGIN": { "type": "string", "description": "| Login for connecting to the server ||" }, "PASSWORD": { "type": "string", "description": "| Password for connecting to the server. Maximum length — 100 characters." }, "TYPE": { "type": "string", "description": "| Type of PBX." }, "TITLE": { "type": "string", "description": "| Name of the connection." } }, "required": [ "SERVER", "LOGIN" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "SERVER": { "type": "string", "description": "| Address of the SIP registration server ||" }, "LOGIN": { "type": "string", "description": "| Login for connecting to the server ||" }, "PASSWORD": { "type": "string", "description": "| Password for connecting to the server. Maximum length — 100 characters." }, "TYPE": { "type": "string", "description": "| Type of PBX." }, "TITLE": { "type": "string", "description": "| Name of the connection." } }, "required": [ "SERVER", "LOGIN" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.connector.status": { "post": { "summary": "Get the Status of the SIP Connector voximplant.sip.connector.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.connector.status` returns the current status of the SIP connector.", "operationId": "voximplant_sip_connector_status", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-connector-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.delete": { "post": { "summary": "Delete SIP Line voximplant.sip.delete", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.delete` removes an existing SIP line created by the current application.", "operationId": "voximplant_sip_delete", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-delete.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.get": { "post": { "summary": "Get SIP Lines of the Application voximplant.sip.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.get` returns a list of SIP lines created by the current application.", "operationId": "voximplant_sip_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Sorting field." }, "ORDER": { "type": "string", "description": "| Sorting direction." }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Internal identifier of the SIP line record." }, "TYPE": { "type": "string", "description": "| Type of PBX." }, "TITLE": { "type": "string", "description": "| Connection name. ||" }, "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration. ||" }, "REG_ID": { "type": "integer", "description": "| Identifier of the SIP registration." }, "APP_ID": { "type": "string", "description": "| Application identifier." }, "SERVER": { "type": "string", "description": "| Address of the SIP registration server. ||" }, "LOGIN": { "type": "string", "description": "| Login for connecting to the server. ||" }, "PASSWORD": { "type": "string", "description": "| Password for connecting to the server. ||" }, "INCOMING_SERVER": { "type": "string", "description": "| Address of the server for incoming calls." }, "INCOMING_LOGIN": { "type": "string", "description": "| Login for incoming calls." }, "INCOMING_PASSWORD": { "type": "string", "description": "| Password for incoming calls." }, "AUTH_USER": { "type": "string", "description": "| Username for authentication. ||" }, "OUTBOUND_PROXY": { "type": "string", "description": "| Address of the SIP proxy for outgoing connection to the operator or PBX. ||" }, "DETECT_LINE_NUMBER": { "type": "string", "description": "| Indicator for line number detection." }, "LINE_DETECT_HEADER_ORDER": { "type": "string", "description": "| Order of headers for line number detection. ||" }, "REGISTRATION_STATUS_CODE": { "type": "integer", "description": "| SIP registration status code. ||" }, "REGISTRATION_ERROR_MESSAGE": { "type": "string", "description": "| SIP registration error message. ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| Object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Sorting field." }, "ORDER": { "type": "string", "description": "| Sorting direction." }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Internal identifier of the SIP line record." }, "TYPE": { "type": "string", "description": "| Type of PBX." }, "TITLE": { "type": "string", "description": "| Connection name. ||" }, "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration. ||" }, "REG_ID": { "type": "integer", "description": "| Identifier of the SIP registration." }, "APP_ID": { "type": "string", "description": "| Application identifier." }, "SERVER": { "type": "string", "description": "| Address of the SIP registration server. ||" }, "LOGIN": { "type": "string", "description": "| Login for connecting to the server. ||" }, "PASSWORD": { "type": "string", "description": "| Password for connecting to the server. ||" }, "INCOMING_SERVER": { "type": "string", "description": "| Address of the server for incoming calls." }, "INCOMING_LOGIN": { "type": "string", "description": "| Login for incoming calls." }, "INCOMING_PASSWORD": { "type": "string", "description": "| Password for incoming calls." }, "AUTH_USER": { "type": "string", "description": "| Username for authentication. ||" }, "OUTBOUND_PROXY": { "type": "string", "description": "| Address of the SIP proxy for outgoing connection to the operator or PBX. ||" }, "DETECT_LINE_NUMBER": { "type": "string", "description": "| Indicator for line number detection." }, "LINE_DETECT_HEADER_ORDER": { "type": "string", "description": "| Order of headers for line number detection. ||" }, "REGISTRATION_STATUS_CODE": { "type": "integer", "description": "| SIP registration status code. ||" }, "REGISTRATION_ERROR_MESSAGE": { "type": "string", "description": "| SIP registration error message. ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.status": { "post": { "summary": "Get SIP Registration Status voximplant.sip.status", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.status` returns the current SIP registration status for the cloud PBX.", "operationId": "voximplant_sip_status", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-status.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "REG_ID": { "type": "integer", "description": "| Identifier of the SIP registration." } }, "required": [ "REG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "REG_ID": { "type": "integer", "description": "| Identifier of the SIP registration." } }, "required": [ "REG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.sip.update": { "post": { "summary": "Update SIP Line voximplant.sip.update", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.sip.update` updates an existing SIP line created by the current application.", "operationId": "voximplant_sip_update", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/sip/voximplant-sip-update.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." }, "TITLE": { "type": "string", "description": "| New name for the connection. ||" }, "SERVER": { "type": "string", "description": "| New SIP registration server address. ||" }, "LOGIN": { "type": "string", "description": "| New login for connecting to the server. ||" }, "PASSWORD": { "type": "string", "description": "| New password for connecting to the server. Maximum length is 100 characters. ||" } }, "required": [ "CONFIG_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "CONFIG_ID": { "type": "integer", "description": "| Identifier of the SIP line configuration." }, "TITLE": { "type": "string", "description": "| New name for the connection. ||" }, "SERVER": { "type": "string", "description": "| New SIP registration server address. ||" }, "LOGIN": { "type": "string", "description": "| New login for connecting to the server. ||" }, "PASSWORD": { "type": "string", "description": "| New password for connecting to the server. Maximum length is 100 characters. ||" } }, "required": [ "CONFIG_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.statistic.get": { "post": { "summary": "Get Call History List voximplant.statistic.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.statistic.get` returns a list of calls from telephony statistics.", "operationId": "voximplant_statistic_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-statistic-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| An object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Sorting field." }, "ORDER": { "type": "string", "description": "| Sorting direction." }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Internal identifier of the statistics record ||" }, "CALL_ID": { "type": "string", "description": "| Call identifier ||" }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Call identifier on the external PBX/integration side ||" }, "CALL_CATEGORY": { "type": "string", "description": "| Call category ||" }, "PORTAL_USER_ID": { "type": "integer", "description": "| User identifier." }, "PORTAL_NUMBER": { "type": "string", "description": "| Line number through which the call was made ||" }, "PHONE_NUMBER": { "type": "string", "description": "| Subscriber number ||" }, "CALL_TYPE": { "type": "integer", "description": "| Type of call." }, "CALL_DURATION": { "type": "integer", "description": "| Duration of the call in seconds ||" }, "CALL_START_DATE": { "type": "string", "format": "date-time", "description": "| Date and time of the call start in ISO-8601 format with timezone indication ||" }, "CALL_LOG": { "type": "string", "description": "| Call log URL ||" }, "CALL_RECORD_URL": { "type": "string", "description": "| Call recording URL ||" }, "CALL_VOTE": { "type": "integer", "description": "| Call rating." }, "COST": { "type": "number", "format": "double", "description": "| Cost of the call ||" }, "COST_CURRENCY": { "type": "string", "description": "| Currency of the call cost ||" }, "CALL_FAILED_CODE": { "type": "string", "description": "| Call result code." }, "CALL_FAILED_REASON": { "type": "string", "description": "| Text of the reason/result of the call ||" }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of CRM entity." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Identifier of the CRM entity from `CRM_ENTITY_TYPE` ||" }, "CRM_ACTIVITY_ID": { "type": "integer", "description": "| Identifier of the CRM activity for the call ||" }, "REST_APP_ID": { "type": "integer", "description": "| Application identifier ||" }, "REST_APP_NAME": { "type": "string", "description": "| Application name ||" }, "TRANSCRIPT_ID": { "type": "integer", "description": "| Identifier of the call transcript ||" }, "TRANSCRIPT_PENDING": { "type": "string", "description": "| Indicator of pending transcription." }, "SESSION_ID": { "type": "integer", "description": "| Session identifier on the telephony side ||" }, "REDIAL_ATTEMPT": { "type": "integer", "description": "| Number of redial attempts (for callback scenarios) ||" }, "COMMENT": { "type": "string", "description": "| Comment on the call ||" }, "RECORD_DURATION": { "type": "integer", "description": "| Duration of the call recording file ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "FILTER": { "type": "object", "description": "| An object for filtering in the format `{\"field_1\": \"value_1\", ... \"field_N\": \"value_N\"}`." }, "SORT": { "type": "string", "description": "| Sorting field." }, "ORDER": { "type": "string", "description": "| Sorting direction." }, "start": { "type": "integer", "description": "| Pagination parameter." }, "ID": { "type": "integer", "description": "| Internal identifier of the statistics record ||" }, "CALL_ID": { "type": "string", "description": "| Call identifier ||" }, "EXTERNAL_CALL_ID": { "type": "string", "description": "| Call identifier on the external PBX/integration side ||" }, "CALL_CATEGORY": { "type": "string", "description": "| Call category ||" }, "PORTAL_USER_ID": { "type": "integer", "description": "| User identifier." }, "PORTAL_NUMBER": { "type": "string", "description": "| Line number through which the call was made ||" }, "PHONE_NUMBER": { "type": "string", "description": "| Subscriber number ||" }, "CALL_TYPE": { "type": "integer", "description": "| Type of call." }, "CALL_DURATION": { "type": "integer", "description": "| Duration of the call in seconds ||" }, "CALL_START_DATE": { "type": "string", "format": "date-time", "description": "| Date and time of the call start in ISO-8601 format with timezone indication ||" }, "CALL_LOG": { "type": "string", "description": "| Call log URL ||" }, "CALL_RECORD_URL": { "type": "string", "description": "| Call recording URL ||" }, "CALL_VOTE": { "type": "integer", "description": "| Call rating." }, "COST": { "type": "number", "format": "double", "description": "| Cost of the call ||" }, "COST_CURRENCY": { "type": "string", "description": "| Currency of the call cost ||" }, "CALL_FAILED_CODE": { "type": "string", "description": "| Call result code." }, "CALL_FAILED_REASON": { "type": "string", "description": "| Text of the reason/result of the call ||" }, "CRM_ENTITY_TYPE": { "type": "string", "description": "| Type of CRM entity." }, "CRM_ENTITY_ID": { "type": "integer", "description": "| Identifier of the CRM entity from `CRM_ENTITY_TYPE` ||" }, "CRM_ACTIVITY_ID": { "type": "integer", "description": "| Identifier of the CRM activity for the call ||" }, "REST_APP_ID": { "type": "integer", "description": "| Application identifier ||" }, "REST_APP_NAME": { "type": "string", "description": "| Application name ||" }, "TRANSCRIPT_ID": { "type": "integer", "description": "| Identifier of the call transcript ||" }, "TRANSCRIPT_PENDING": { "type": "string", "description": "| Indicator of pending transcription." }, "SESSION_ID": { "type": "integer", "description": "| Session identifier on the telephony side ||" }, "REDIAL_ATTEMPT": { "type": "integer", "description": "| Number of redial attempts (for callback scenarios) ||" }, "COMMENT": { "type": "string", "description": "| Comment on the call ||" }, "RECORD_DURATION": { "type": "integer", "description": "| Duration of the call recording file ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.tts.voices.get": { "post": { "summary": "Get a List of Available Voices for Text-to-Speech voximplant.tts.voices.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.tts.voices.get` returns a list of available voices for text-to-speech synthesis.", "operationId": "voximplant_tts_voices_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-tts-voices-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.url.get": { "post": { "summary": "Get Links for Navigation in the Telephony Pages voximplant.url.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.url.get` returns links for navigation in the telephony pages.", "operationId": "voximplant_url_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/voximplant-url-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.user.activatePhone": { "post": { "summary": "Activate User SIP Device voximplant.user.activatePhone", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.user.activatePhone` sets a flag indicating the presence of a SIP device for an employee.", "operationId": "voximplant_user_activatePhone", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/users/voximplant-user-activate-phone.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } }, "required": [ "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "integer", "description": "| User identifier." } }, "required": [ "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] }, { "OAuth2": [ "telephony" ] } ] } }, "/voximplant.user.deactivatePhone": { "post": { "summary": "Deactivate the employee's SIP phone presence with voximplant.user.deactivatePhone", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Some data may be missing here — we will complete it shortly. - The required parameters are not specified - Examples are missing", "operationId": "voximplant_user_deactivatePhone", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/users/voximplant-user-deactivate-phone.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "/ Type | Description ||" } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Parameter": { "type": "string", "description": "/ Type | Description ||" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (400, 401, 403)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixError" } } } } }, "security": [ { "AccessToken": [] } ] } }, "/voximplant.user.get": { "post": { "summary": "Get User Settings voximplant.user.get", "description": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `voximplant.user.get` returns user settings. For applications, calling the method requires [administrator confirmation](../../../scopes/confirmation.md).", "operationId": "voximplant_user_get", "tags": [ "Telephony" ], "externalDocs": { "url": "https://apidocs.bitrix24.com/api-reference/telephony/voximplant/users/voximplant-user-get.html", "description": "Official Documentation" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "string", "description": "| User ID or an array of user IDs." } }, "required": [ "USER_ID" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "USER_ID": { "type": "string", "description": "| User ID or an array of user IDs." } }, "required": [ "USER_ID" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitrixResponse" } } } }, "4XX": { "description": "Request error (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 or incoming webhook token" }, "OAuth2": { "type": "oauth2", "description": "OAuth 2.0 authorization", "flows": { "authorizationCode": { "authorizationUrl": "https://oauth.bitrix.info/oauth/authorize/", "tokenUrl": "https://oauth.bitrix.info/oauth/token/", "scopes": { "crm": "CRM — leads, deals, contacts, companies, smart processes", "task": "Tasks and projects", "disk": "Drive — files and folders", "im": "Chats and notifications", "imbot": "Chatbots", "imopenlines": "Open Lines — messenger connectors", "telephony": "Telephony", "sale": "E-Commerce — orders, shipments", "catalog": "Trade Catalog — products, prices", "calendar": "Calendar", "bizproc": "Business processes and robots", "user": "Users", "department": "Company structure", "timeman": "Time tracking", "landing": "Sites and landing pages", "pay_system": "Payment systems", "cashbox": "Online cash registers", "delivery": "Delivery services", "documentgenerator": "Document generator", "lists": "Universal lists", "entity": "Data storage", "log": "News feed", "sonet_group": "Workgroups and projects", "mailservice": "Mail services", "messageservice": "Message providers (SMS)", "biconnector": "BIconnector — BI analytics", "ai_admin": "CoPilot / AI", "sign.b2e": "Signature — e-document signing", "vote": "Polls and voting", "booking": "Online booking", "userconsent": "User consent agreements", "userfieldconfig": "Custom field settings", "basic": "Basic access", "placement": "Widget placements", "rpa": "Robots process automation", "sonet": "Social network", "intranet": "Intranet", "socialnetwork": "Social network", "workgroups": "Workgroups", "salescenter": "Sales center", "main": "Main module", "imconnector": "IM connector", "user.userfield": "User custom fields", "user_basic": "Basic user access", "userfieldconfig, module scope": "Custom field config" } } } } }, "schemas": { "BitrixResponse": { "type": "object", "description": "Standard Bitrix24 REST API response", "properties": { "result": { "description": "Method execution result" }, "total": { "type": "integer", "description": "Total number of records (for list methods)" }, "next": { "type": "integer", "description": "Next offset for pagination" }, "time": { "$ref": "#/components/schemas/BitrixTime" } } }, "BitrixError": { "type": "object", "description": "Bitrix24 REST API error response", "required": [ "error", "error_description" ], "properties": { "error": { "type": "string", "description": "Error code", "example": "ACCESS_DENIED" }, "error_description": { "type": "string", "description": "Human-readable error description", "example": "Access denied." } } }, "BitrixTime": { "type": "object", "description": "Request execution time information", "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" } } } } } }