Для AI-агентов: markdown этой страницы — /docs-content/note/collections/update.md индекс документации — /llms.txt

Переименовать базу знаний

PATCH /v1/note/collections/:id

Изменяет название существующей базы знаний. Тело передаётся плоско, без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
id (path) integer да Идентификатор базы знаний

Поля запроса (body)

Поле Тип Обяз. Описание
name string да Новое название базы знаний

Примеры

curl — личный ключ

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Документация продукта"
  }'

curl — OAuth-приложение

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Документация продукта"
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Документация продукта',
  }),
})

const { success, data } = await res.json()
console.log('Переименовано:', data.updated)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/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: 'Документация продукта',
  }),
})

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

Поля ответа

Поле Тип Описание
data.updated boolean true при успешном переименовании

Пример ответа

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

Пример ответа при ошибке

400 — не передан name:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан name, либо id не является положительным целым числом
404 ENTITY_NOT_FOUND База знаний не существует, удалена или архивирована
403 BITRIX_ACCESS_DENIED Нет права управлять этой базой знаний
502 BITRIX_UNAVAILABLE Битрикс24 недоступен
403 SCOPE_DENIED Ключу не хватает скоупа note
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме «только чтение»
401 TOKEN_MISSING У ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также