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

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

PATCH /v1/note/collections/:id

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

Параметры

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

Поля запроса (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()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеРезультат переименования
Поле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 Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан name, либо id не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеБаза знаний не существует или удалена
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права управлять этой базой знаний, либо база знаний архивирована
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме «только чтение»
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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