For AI agents: markdown of this page — /docs-content-en/note/documents/archive.md documentation index — /llms.txt

Archive a document

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

Archives a document together with its entire subtree. Archived documents can be read but not edited.

Parameters

Parameter In Type Required Description
id path integer yes Identifier of the subtree root document

The request body is empty.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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 application

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

Response fields

Field Type Description
data.archived boolean true on successful archiving

Response example

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

Error response example

404 — document not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Record with ID = `999999` not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS id is not a positive integer
403 WRITE_BLOCKED_READONLY_KEY The access key is read-only
403 BITRIX_ACCESS_DENIED No permission to edit the document
404 ENTITY_NOT_FOUND The document does not exist, is in the trash, or is already archived
403 SCOPE_DENIED The key lacks the note scope
401 TOKEN_MISSING The key has no tokens configured

Full list of common API errors — Errors.

Known specifics

See also