archive_document
Soft-archive a saved document — it leaves the Files view but is recoverable server-side.
Presence-aware: if the document is currently open in ANOTHER session and force is not set,
the request FAILS honestly with HTTP 409 (code:"document_in_use" + open_in_sessions:N +
suggested_action) so callers can confirm "open in N other session(s) — delete anyway?" and
re-call with force=true. On force=true it archives, unlinks every session, and notifies the
other sessions (which then prompt the user to keep editing or honor the deletion).
A no-op never wears a success status: if nothing was archived you get the 409 above, so a 2xx always means the archive actually happened.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Confirm deletion of a doc that is open in another session. Without it, deleting an in-use doc fails with HTTP 409 (code document_in_use, open_in_sessions:N) instead of tombstoning — nothing is archived until you re-call with force=true. | |
| document_id | Yes | ||
| from_session | No | The caller's own session id (so it is excluded from the in-use check). Omit for a pure Files-view delete. | |
| authorization | No |