Rename a chat

PATCH /v1/chats/:chatId

Changes the name of a group chat. The caller must be a member of the chat with permission to rename it.

Parameters

The v2 mode. format=v2 changes a group chat as a whole in one call — the v2 messenger method im.v2.Chat.update: the name, description, avatar, owner, type, permissions, members and managers. The title field becomes optional, but at least one field is required. Every field is checked before any call to Bitrix24: an unknown field, a wrong type or a value outside the list is rejected with 400 INVALID_PARAMS naming the field. The v2 mode requires the permission to change the chat — the owner has it by default — rather than the rename permission, which is enough without the parameter. Bitrix24 checks the rest itself: it rejects a personal dialog with 422 BITRIX_ERROR and error.b24Code WRONG_MESSAGE_TYPE. In the response data is the object { result: true }. To only rename a chat under the rename permission, call the endpoint without format.

Request fields (body)

Examples

curl — personal key

curl -X PATCH https://vibecode.bitrix24.com/v1/chats/3663 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Project Beta"
  }'

curl — OAuth application

curl -X PATCH https://vibecode.bitrix24.com/v1/chats/3663 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Project Beta"
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/3663', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Project Beta',
  }),
})

const { success, data } = await res.json()
console.log('Renamed:', data) // true

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/3663', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Project Beta',
  }),
})

const { success, data } = await res.json()

curl — the v2 mode

curl -X PATCH "https://vibecode.bitrix24.com/v1/chats/3663?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Release discussion",
    "addedManagers": [27],
    "manageMessages": "MANAGER"
  }'

Response fields

Response example

{
  "success": true,
  "data": true
}

Error response example

400 — an empty title was passed:

{
  "success": false,
  "error": {
    "code": "TITLE_EMPTY",
    "message": "title is required and cannot be blank."
  }
}

Errors

Full list of common API errors — Errors.

Known specifics

An avatar in the request body. The request body is limited to 1 MiB, and base64 inflates an image by a third: the avatar field fits an image of up to about 750 KiB. Upload a larger image to Drive and pass the file ID.

Two permissions, two modes. Without format the chat is renamed by a member with the rename permission, and the endpoint first checks that the caller is a chat member. In the v2 mode the permission to change the chat is required, and Bitrix24 runs the checks.

See also

• Chat management
• Transfer ownership
• Add members