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

Rename a knowledge base

PATCH /v1/note/collections/:id

Changes the name of an existing knowledge base. The body is passed flat, without a fields wrapper.

Parameters

Parameter Type Required Description
Parameterid (path) Typeinteger Requiredyes DescriptionKnowledge base identifier. List: GET /v1/note/collections

Request fields (body)

Field Type Required Description
Fieldname Typestring Requiredyes DescriptionNew knowledge base name

Examples

curl — personal key

Terminal 
curl -X PATCH https://vibecode.bitrix24.com/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product docs"
  }'

curl — OAuth application

Terminal 
curl -X PATCH https://vibecode.bitrix24.com/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product docs"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/note/collections/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Product docs',
  }),
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/note/collections/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Product docs',
  }),
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionRename result
Fielddata.updated Typeboolean Descriptiontrue on successful rename

Response example

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

Error response example

400 — name not provided:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`name` is required and must be a non-empty string"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionname not provided, or id is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe knowledge base does not exist or has been deleted
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo permission to manage this knowledge base, or the knowledge base is archived
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the note scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key operates in read-only mode
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens

Full list of common API errors — Errors.

See also