How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 Chats API

The Chats API from Bitrix24 — 67 operation(s) for chats.

Bitrix24 Chats API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chats. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 67 operations across 67 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

67 operations 67 paths 3 schemas 67 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 Chats API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 67

Across 67 paths, the API surfaces 67 operations — 67 POST. Each is listed below with its method, path, parameters, and response codes.

Chats 67
POST
/im.chat.add
Create Chat im.chat.add
im_chat_add body → 2004XX
POST
/im.chat.get
Get Chat ID im.chat.get
im_chat_get body → 2004XX
POST
/im.chat.leave
Leave Chat im.chat.leave
im_chat_leave body → 2004XX
POST
/im.chat.mute
Disable Notifications from Chat im.chat.mute
im_chat_mute body → 2004XX
POST
/im.chat.setOwner
Change Chat Owner im.chat.setOwner
im_chat_setOwner body → 2004XX
POST
/im.chat.updateAvatar
Update Chat Avatar im.chat.updateAvatar
im_chat_updateAvatar body → 2004XX
POST
/im.chat.updateColor
Change Chat Color im.chat.updateColor
im_chat_updateColor body → 2004XX
POST
/im.chat.updateTitle
Update Chat Title im.chat.updateTitle
im_chat_updateTitle body → 2004XX
POST
/im.chat.user.add
Invite Participants to Chat im.chat.user.add
im_chat_user_add body → 2004XX
POST
/im.chat.user.delete
Exclude Participants from Chat im.chat.user.delete
im_chat_user_delete body → 2004XX
POST
/im.chat.user.list
Get Chat Participant IDs im.chat.user.list
im_chat_user_list body → 2004XX
POST
/im.counters.get
Get Counters im.counters.get
im_counters_get body → 2004XX
POST
/im.department.colleagues.list
Get the List of Colleagues for the Current User im.department.colleagues.list
im_department_colleagues_list body → 2004XX
POST
/im.department.employees.get
Get a List of Employees from Departments im.department.employees.get
im_department_employees_get body → 2004XX
POST
/im.department.get
Get Information About the Department im.department.get
im_department_get body → 2004XX
POST
/im.department.managers.get
Get a List of Department Managers im.department.managers.get
im_department_managers_get body → 2004XX
POST
/im.dialog.get
Get Chat Data im.dialog.get
im_dialog_get body → 2004XX
POST
/im.dialog.messages.get
Get the List of Recent Messages im.dialog.messages.get
im_dialog_messages_get body → 2004XX
POST
/im.dialog.messages.search
Find Message in Chat im.dialog.messages.search
im_dialog_messages_search body → 2004XX
POST
/im.dialog.read
Set the "read" flag for messages im.dialog.read
im_dialog_read body → 2004XX
POST
/im.dialog.read.all
Set the "read" flag for all chats im.dialog.read.all
im_dialog_read_all body → 2004XX
POST
/im.dialog.unread
Set the "unread" flag for messages im.dialog.unread
im_dialog_unread body → 2004XX
POST
/im.dialog.users.list
Get the List of Participants im.dialog.users.list
im_dialog_users_list body → 2004XX
POST
/im.dialog.writing
Send "User is typing" indicator im.dialog.writing
im_dialog_writing body → 2004XX
POST
/im.disk.file.commit
Add File to Chat im.disk.file.commit
im_disk_file_commit body → 2004XX
POST
/im.disk.file.delete
Delete File from Chat Folder im.disk.file.delete
im_disk_file_delete body → 2004XX
POST
/im.disk.file.save
Save File to Your Drive im.disk.file.save
im_disk_file_save body → 2004XX
POST
/im.disk.folder.get
Get Chat File Storage Folder im.disk.folder.get
im_disk_folder_get body → 2004XX
POST
/im.message.add
Send Message im.message.add
im_message_add body → 2004XX
POST
/im.message.command
Execute the chat-bot command im.message.command
im_message_command body → 2004XX
POST
/im.message.delete
Delete Message im.message.delete
im_message_delete body → 2004XX
POST
/im.message.like
Change Status to "Like" im.message.like
im_message_like body → 2004XX
POST
/im.message.share
Create an Object Based on the Message im.message.share
im_message_share body → 2004XX
POST
/im.message.update
Update Message im.message.update
im_message_update body → 2004XX
POST
/im.notify
Send Notification im.notify
im_notify body → 2004XX
POST
/im.notify.answer
Responding to Notifications with Quick Response im.notify.answer
im_notify_answer body → 2004XX
POST
/im.notify.confirm
Interacting with Notification Buttons im.notify.confirm
im_notify_confirm body → 2004XX
POST
/im.notify.delete
Delete Notification im.notify.delete
im_notify_delete body → 2004XX
POST
/im.notify.get
Get Notifications im.notify.get
im_notify_get body → 2004XX
POST
/im.notify.history.search
Searching Notification History im.notify.history.search
im_notify_history_search body → 2004XX
POST
/im.notify.personal.add
Send Personal Notification im.notify.personal.add
im_notify_personal_add body → 2004XX
POST
/im.notify.read
Read or Mark Notification as Unread im.notify.read
im_notify_read body → 2004XX
POST
/im.notify.read.all
Read All Notifications im.notify.read.all
im_notify_read_all body → 2004XX
POST
/im.notify.read.list
Read the list of notifications im.notify.read.list
im_notify_read_list body → 2004XX
POST
/im.notify.schema.get
Get Notification Type Schema im.notify.schema.get
im_notify_schema_get body → 2004XX
POST
/im.notify.system.add
Send System Notification im.notify.system.add
im_notify_system_add body → 2004XX
POST
/im.recent
Pin a Chat at the Top of the im.recent List
im_recent body → 2004XX
POST
/im.recent.get
Get a Shortened List of Recent Chats im.recent.get
im_recent_get body → 2004XX
POST
/im.recent.hide
Remove Chat from the Recent List im.recent.hide
im_recent_hide body → 2004XX
POST
/im.recent.list
Get the List of Chats im.recent.list
im_recent_list body → 2004XX
POST
/im.recent.unread
Set or Remove the "Read" Flag for the Chat im.recent.unread
im_recent_unread body → 2004XX
POST
/im.revision.get
Get API Revisions im.revision.get
im_revision_get body → 2004XX
POST
/im.search.chat.list
Find Chats im.search.chat.list
im_search_chat_list body → 2004XX
POST
/im.search.department.list
Find Departments im.search.department.list
im_search_department_list body → 2004XX
POST
/im.search.last.add
Add Entry to Search History im.search.last.add
im_search_last_add body → 2004XX
POST
/im.search.last.delete
Delete Record from Search History im.search.last.delete
im_search_last_delete body → 2004XX
POST
/im.search.last.get
Get Search History im.search.last.get
im_search_last_get body → 2004XX
POST
/im.search.user.list
Find Users im.search.user.list
im_search_user_list body → 2004XX
POST
/im.user.get
Get User Data im.user.get
im_user_get body → 2004XX
POST
/im.user.list.get
Get User Data with im.user.list.get
im_user_list_get body → 2004XX
POST
/im.user.status.get
Get User Status im.user.status.get
im_user_status_get body → 2004XX
POST
/im.user.status.idle.end
Disable Automatic Status "Away" im.user.status.idle.end
im_user_status_idle_end body → 2004XX
POST
/im.user.status.idle.start
Enable Automatic Status "Away" im.user.status.idle.start
im_user_status_idle_start body → 2004XX
POST
/im.user.status.set
Set User Status im.user.status.set
im_user_status_set body → 2004XX
POST
/imbot.app.register
Register a Chat Application imbot.app.register
imbot_app_register body → 2004XX
POST
/imbot.app.unregister
Unregister Chat Application imbot.app.unregister
imbot_app_unregister body → 2004XX
POST
/imbot.app.update
Update Application Data in Chat imbot.app.update
imbot_app_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-chats-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chatbots API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Bitrix24 Drive API
Where this information came from

This is an independent, third-party profile of Bitrix24 Chats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.