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

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

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

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

Параметры

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

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

Примеры

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',
  },
})

Поля ответа

Поле Тип Описание
data.archived boolean true при успешной архивации

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

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

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

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

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

Ошибки

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

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

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

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

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