For AI agents: markdown of this page — /docs-content-en/chats/management/rename.md documentation index — /llms.txt

Rename a chat

PATCH /v1/chats/:chatId

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

Parameters

Parameter Type Required Description
chatId (path) number yes Numeric chat ID. Obtain it via: POST /v1/chats or GET /v1/chats/recent

Request fields (body)

Field Type Required Description
title string yes New chat name. Cannot be empty

Examples

curl — personal key

Terminal 
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

Terminal 
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

javascript 
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

javascript 
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()

Response fields

Field Type Description
success boolean Always true on success
data boolean true when the rename succeeded

Response example

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

Error response example

400 — an empty title was passed:

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

Errors

HTTP Code Description
400 INVALID_CHAT_ID chatId is not a positive integer
400 TITLE_EMPTY The title field is missing or empty
404 CHAT_NOT_FOUND_OR_NO_ACCESS The chat does not exist or the caller has no permission to rename it
403 SCOPE_DENIED The API key lacks the im scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

See also