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

Update a chat folder

PATCH /v1/chats/folders/:folderId

Renames the current user's personal chat folder and replaces its contents.

To add or remove individual chats without passing the full contents, see Add chats to a folder and Remove chats from a folder.

Parameters

Parameter	Type	Required	Description
`folderId` (path)	number	yes	Personal folder ID — the `id` field in `GET /v1/chats/folders`. A positive integer

There are no query parameters: any query parameter is rejected with 400 INVALID_PARAMS.

Request fields (body)

Field	Type	Required	Description
`title`	string	no	New folder name, 1 to 30 characters after trimming whitespace. A name outside these bounds is rejected with `422 BITRIX_ERROR`, not `400`
`chatIds`	number[]	no	Chat IDs of the new contents. Each element is a positive integer: a number or a string of digits. The chat ID is the `id` field in recent dialogs
`dialogIds`	string[]	no	Dialog IDs of the new contents: `chatXXX` or a user ID for a direct dialog. An element is a non-empty string of up to 64 characters, with no commas and no leading or trailing whitespace. The `me` alias is not accepted — pass the user ID. The ID is the `dialogId` field in recent dialogs

At least one of title, chatIds, dialogIds is required. The passed contents — the union of chatIds and dialogIds — replace the previous contents entirely. Empty contents — chatIds: [], dialogIds: [] or both — clear the folder. Any other body field is rejected with 400 INVALID_PARAMS.

Examples

curl — personal key

Terminal

curl -X PATCH "https://vibecode.bitrix24.com/v1/chats/folders/127" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Key clients", "chatIds": [5287]}'

curl — OAuth application

Terminal

curl -X PATCH "https://vibecode.bitrix24.com/v1/chats/folders/127" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Key clients", "chatIds": [5287]}'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/folders/127', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Key clients', chatIds: [5287] }),
})

const { success, data } = await res.json()
console.log(data.folder.definition.chats)

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/chats/folders/127', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Key clients', chatIds: [5287] }),
})

const { success, data } = await res.json()
console.log(data.folder.definition.chats)

Response fields

Field	Type	Description
`success`	boolean	Always `true` on success
`data.folder`	object	The folder after the update
`data.folder.id`	number	Folder ID
`data.folder.type`	string	Always `personal`
`data.folder.title`	string	Name
`data.folder.sort`	number	Folder order in the interface
`data.folder.visible`	boolean	The folder is shown in the interface
`data.folder.description`	null	A personal folder has no description
`data.folder.displaysNestedInRoot`	boolean	Nested chats are also shown in the root list
`data.folder.definition.chats`	array	Folder contents after the update, a list of `{ chatId, dialogId }`

Response example

JSON

{
  "success": true,
  "data": {
    "folder": {
      "id": 127,
      "type": "personal",
      "title": "Key clients",
      "sort": 12,
      "visible": true,
      "description": null,
      "displaysNestedInRoot": false,
      "definition": {
        "chats": [{ "chatId": 5287, "dialogId": "chat5287" }]
      }
    }
  }
}

Error response example

400 — no field passed: