## Архивировать базу знаний

`POST /v1/note/collections/:id/archive`

Архивирует базу знаний. Каскадно архивирует все её документы — они переходят в режим чтения.

## Параметры

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

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

## Примеры

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections/42/archive \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections/42/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/collections/42/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/collections/42/archive', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `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` не положительное целое |
| 404 | `ENTITY_NOT_FOUND` | База знаний не существует или уже архивирована |
| 403 | `BITRIX_ACCESS_DENIED` | Нет права управления базой знаний |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ в режиме «только чтение» |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `note` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- Документы архивированной базы знаний не возвращаются в [дереве документов](/docs/note/documents).

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

- [Удалить базу знаний](./delete.md)
- [Документы](/docs/note/documents)
- [Обзор Базы знаний](/docs/note)