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

Архивировать документ

POST /v1/note/documents/:id/archive

Архивирует документ вместе со всем его поддеревом. Архивные документы доступны для чтения, но не для редактирования.

Параметры

Параметр Где Тип Обяз. Описание
Параметрid Гдеpath Типinteger Обяз.да ОписаниеИдентификатор корневого документа поддерева. Список: GET /v1/note/documents

Тело запроса пустое.

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents/77/archive \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/documents/77/archive \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/archive', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log(data.archived) // true

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77/archive', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеРезультат архивации
Полеdata.archived Типboolean Описаниеtrue при успешной архивации

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

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

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

404 — документ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999` не найдена"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не положительное целое
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч доступа работает только на чтение
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права редактировать документ
HTTP404 КодENTITY_NOT_FOUND ОписаниеДокумент не существует, в корзине или уже архивирован
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа не настроены токены

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

Известные особенности

  • Архивный документ нельзя обновить. Вызов PATCH /v1/note/documents/:id на архивном документе возвращает 404 ENTITY_NOT_FOUND.

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