openapi: 3.0.3 info: title: Bitrix24 REST BIconnector CRM 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 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: CRM paths: /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 /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 /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 components: schemas: 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 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' 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 externalDocs: description: Official Bitrix24 REST API Documentation url: https://apidocs.bitrix24.com