Chat Update: Overview of Methods

After creating a chat, you can assign a different owner or change its appearance: the title, color, and avatar. In the messenger interface, the title is called the chat name, and the avatar is called the icon. Each property is changed by its own method — to change several properties, call the required methods one after another. The subsection is part of the Chats in Bitrix24 section.

The methods of this subsection are current and have no deprecated counterparts — use them to update a chat.

Quick navigation: all methods

User documentation: Chats in Bitrix24: Interface and Capabilities

Who Can Change a ChatWho Can Change a Chat

Only the current chat owner can change the owner.

Who can change the appearance is defined by a chat setting. Its current value is returned by the im.dialog.get method in the manage_ui field of the permissions object:

• member — any chat participant can change the appearance
• manager — the chat owner and administrators
• owner — only the owner

If the required permission is missing, the method returns an error. The exact codes are listed in the "Error Handling" section on the page of each method.

You can add the future owner to the chat with the methods of the Chat Participants subsection. System messages about the changes arrive in the conversation — working with them is described in the Messages subsection.

Relationship of Methods with Other ObjectsRelationship of Methods with Other Objects

Chat. To change the chat properties, pass the chat identifier CHAT_ID to the method. You can obtain the chat identifier using the method:

• creating a chat
• getting the chat identifier
• getting the list of chats
• getting a shortened list of recent chats

Pass only a number in CHAT_ID: a value with a prefix, for example chat123, is rejected by the method with the CHAT_ID_EMPTY error. If it is more convenient to work with the dialog identifier, pass the DIALOG_ID parameter with a value like chat123 instead of CHAT_ID.

The methods work only with group chats. For a private dialog, they return the DIALOG_ID_EMPTY error.

You can verify the result of the change with the im.dialog.get method: it returns the current title, owner, avatar, and color of the chat. The color comes as a HEX code, for example #4ba984, and not as a value from the COLOR list.

User. To change the owner of the chat, specify their identifier in the USER_ID parameter. You can obtain the user identifier using the getting the list of users method or the getting the list of chat participants method.

What to Pass When Changing a ChatWhat to Pass When Changing a Chat

What to Change	What to Pass
Chat owner	The identifier of the new owner — they must be a chat participant
Chat title	The new title as a string
Chat avatar	The image itself as a Base64 string, not a link to a file
Chat color	The color name from a fixed list of values

Which method is responsible for each property — see the overview of methods.

Every change is reflected in the conversation by a system message, for example: John Smith changed the chat color to "Mint".

The system selects the color randomly when the chat is created. It is displayed in the mobile application and wherever the chat has no avatar. A title that was not set when the chat was created is generated by the system automatically — such a chat can be renamed as well.

Overview of MethodsOverview of Methods

Scope: im

Who can execute the method: depends on the method

Method	Description
im.chat.setOwner	Changes the chat owner
im.chat.updateTitle	Changes the chat title
im.chat.updateAvatar	Changes the chat avatar
im.chat.updateColor	Changes the chat color