Bitrix24 Deprecated Methods API
The Deprecated Methods API from Bitrix24 — 30 operation(s) for deprecated methods.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Deprecated Methods 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: Deprecated Methods
paths:
/rpa.comment.add:
post:
summary: Create a New Comment in the Timeline rpa.comment.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method creates a new comment in the timeline of the item with the identifier `itemId` for the process with the identifier `typeId`.
operationId: rpa_comment_add
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
itemId:
type: integer
description: '| Identifier of the item ||'
fields:
type: object
description: '| Object describing the fields of the comment ||'
description:
type: string
description: '| Description of the entry. HTML and BB-code formatting can be used ||'
files:
type: array
items: {}
description: '| Array of attached files. Each element is an array containing the name and content encoded in base64 ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
itemId:
type: integer
description: '| Identifier of the item ||'
fields:
type: object
description: '| Object describing the fields of the comment ||'
description:
type: string
description: '| Description of the entry. HTML and BB-code formatting can be used ||'
files:
type: array
items: {}
description: '| Array of attached files. Each element is an array containing the name and content encoded in base64 ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.comment.delete:
post:
summary: Delete Comment rpa.comment.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes a comment with the identifier `id`. It only allows the deletion of comments that were added by the same user.
operationId: rpa_comment_delete
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Record identifier ||'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Record identifier ||'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.comment.update:
post:
summary: Update Timeline Entry rpa.comment.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the timeline entry with the identifier `id`. It only updates the `title` and `description` fields. The method allows changes only to comments that were added by the same user.
operationId: rpa_comment_update
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/comment/rpa-comment-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the comment ||'
fields:
type: object
description: '| An object describing the fields of the comment ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the comment ||'
fields:
type: object
description: '| An object describing the fields of the comment ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.fields.getSettings:
post:
summary: Get the Complete Set of Field Visibility Settings rpa.fields.getSettings
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method retrieves the complete set of field visibility settings for the stage with the identifier `stageId` in the process with the identifier `typeId`.
operationId: rpa_fields_getSettings
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-get-settings.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
stageId:
type: integer
description: '| Identifier of the stage.'
required:
- typeId
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
stageId:
type: integer
description: '| Identifier of the stage.'
required:
- typeId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.fields.setSettings:
post:
summary: Set Full Visibility Settings for rpa.fields.setSettings
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method sets the full visibility settings for fields at the stage with the identifier `stageId` of the process with the identifier `typeId`.
operationId: rpa_fields_setSettings
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-set-settings.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: number
description: '| Identifier of the process ||'
stageId:
type: number
description: '| Identifier of the stage.'
fields:
type: object
description: '| Array with field visibility settings.'
required:
- typeId
- fields
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: number
description: '| Identifier of the process ||'
stageId:
type: number
description: '| Identifier of the stage.'
fields:
type: object
description: '| Array with field visibility settings.'
required:
- typeId
- fields
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.fields.setVisibilitySettings:
post:
summary: Change Field Visibility Settings rpa.fields.setVisibilitySettings
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method updates the `visibility` settings of `fields` for the process with the identifier `typeId` at the stage with the identifier `stageId`. Other settings remain unchanged. The method should be used when you need to change the visibility settings for only one type.
operationId: rpa_fields_setVisibilitySettings
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/fields/rpa-fields-set-visibility-settings.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
visibility:
type: string
description: '| Identifier of the visibility for which the settings are being changed ||'
stageId:
type: integer
description: '| Identifier of the stage.'
fields:
type: array
items: {}
description: '| Array of fields for which the settings need to be changed ||'
required:
- typeId
- visibility
- fields
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
visibility:
type: string
description: '| Identifier of the visibility for which the settings are being changed ||'
stageId:
type: integer
description: '| Identifier of the stage.'
fields:
type: array
items: {}
description: '| Array of fields for which the settings need to be changed ||'
required:
- typeId
- visibility
- fields
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.add:
post:
summary: Add Process Element rpa.item.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method adds a new process element with the identifier `typeId`. To upload a file, you need to pass an array as the value of the custom field, where the first element is the file name and the second is the base64 encoded content of the file.
operationId: rpa_item_add
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
fields:
type: array
items: {}
description: '| Values of the custom fields of the element. All other fields will be ignored ||'
required:
- typeId
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
fields:
type: array
items: {}
description: '| Values of the custom fields of the element. All other fields will be ignored ||'
required:
- typeId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.delete:
post:
summary: Delete Element rpa.item.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method deletes an element.
operationId: rpa_item_delete
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Process identifier ||'
id:
type: integer
description: '| Element identifier ||'
required:
- typeId
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Process identifier ||'
id:
type: integer
description: '| Element identifier ||'
required:
- typeId
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.get:
post:
summary: Get Information About the rpa.item.get Element
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves information about the element with the identifier `id` of the process with the identifier `typeId`.
operationId: rpa_item_get
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
id:
type: integer
description: '| Identifier of the element ||'
Name:
type: string
description: '| Description ||'
stageId:
type: string
description: '| Identifier of the stage the element is currently in ||'
previousStageId:
type: string
description: '| Identifier of the previous stage of the element ||'
name:
type: string
description: '| Name of the element ||'
createdBy:
type: string
description: '| Identifier of the user who created the element ||'
updatedBy:
type: string
description: '| Identifier of the user who modified the element ||'
movedBy:
type: string
description: '| Identifier of the user who changed the stage of the element ||'
createdTime:
type: string
description: '| Time the element was created ||'
updatedTime:
type: string
description: '| Time the element was modified ||'
movedTime:
type: string
description: '| Time the stage of the element was changed ||'
detailUrl:
type: string
description: '| Link to the detail form of the element ||'
tasksCounter:
type: string
description: '| Number of tasks associated with the element for the user ||'
tasksFaces:
type: string
description: '| Information for rendering the sequence of responsible parties during approval:'
users:
type: string
description: '| Aggregated information about all users related to the element. A list where the key is the user identifier:'
UF_RPA_...:
type: string
description: '| Values of custom fields.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
id:
type: integer
description: '| Identifier of the element ||'
Name:
type: string
description: '| Description ||'
stageId:
type: string
description: '| Identifier of the stage the element is currently in ||'
previousStageId:
type: string
description: '| Identifier of the previous stage of the element ||'
name:
type: string
description: '| Name of the element ||'
createdBy:
type: string
description: '| Identifier of the user who created the element ||'
updatedBy:
type: string
description: '| Identifier of the user who modified the element ||'
movedBy:
type: string
description: '| Identifier of the user who changed the stage of the element ||'
createdTime:
type: string
description: '| Time the element was created ||'
updatedTime:
type: string
description: '| Time the element was modified ||'
movedTime:
type: string
description: '| Time the stage of the element was changed ||'
detailUrl:
type: string
description: '| Link to the detail form of the element ||'
tasksCounter:
type: string
description: '| Number of tasks associated with the element for the user ||'
tasksFaces:
type: string
description: '| Information for rendering the sequence of responsible parties during approval:'
users:
type: string
description: '| Aggregated information about all users related to the element. A list where the key is the user identifier:'
UF_RPA_...:
type: string
description: '| Values of custom fields.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.getTasks:
post:
summary: Get Data on Current Tasks of the Element rpa.item.getTasks
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Use [Smart processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves data on the current tasks of the element with the identifier `id` for the process with the identifier `typeId`.
operationId: rpa_item_getTasks
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-get-tasks.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
id:
type: integer
description: '| Identifier of the element ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
id:
type: integer
description: '| Identifier of the element ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.list:
post:
summary: Retrieve an Array of Process Elements rpa.item.list
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart Processes](../../../crm/universal/user-defined-object-types/index.md) as an alternative to this functionality. This method retrieves a list of process elements with the identifier `typeId`.
operationId: rpa_item_list
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
order:
type: number
description: '| List for sorting, where the key is the field and the value is `ASC` or `DESC` ||'
filter:
type: number
description: '| List for filtering.'
start:
type: number
description: '| Offset for pagination. ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
typeId:
type: integer
description: '| Identifier of the process ||'
order:
type: number
description: '| List for sorting, where the key is the field and the value is `ASC` or `DESC` ||'
filter:
type: number
description: '| List for filtering.'
start:
type: number
description: '| Offset for pagination. ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- rpa
/rpa.item.update:
post:
summary: Update Process Element rpa.item.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The development of this method has been halted. Please use [Smart scripts](../../../crm/universal/user-defined-object-types/index.md) as an alternative functionality. This method updates the element with the identifier `id` in the process with the identifier `typeId`.
operationId: rpa_item_update
tags:
- Deprecated Methods
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/outdated/rpa/item/rpa-item-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
typeId:
type: integer
description: '| Process identifier ||'
id:
type: integer
description: '| Element identifier ||'
fields:
type: object
description: '| Object containing values for custom fi
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-deprecated-methods-api-openapi.yml