ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Archive Room

AI-generated

Summary

Archives an ONLYOFFICE DocSpace room by ID and returns the room's info as it was fetched just before archiving.

Inputs

  • Authentication (required) — Credential type used for the API call: API Key (default), Basic Auth, OAuth2, or Personal Access Token. The matching DocSpace credential must be configured.
  • Room ID (required) — The room to archive. Pick it from a searchable list of rooms, or enter the numeric ID manually (validated as a number).

Output shape

One JSON item per input item, containing the room's info object (as returned by DocSpace's get-room endpoint).

The room info is fetched before the archive request, so it shows the pre-archive state, not the updated state. The node sends the archive request with deleteAfter=false and waits for the async file operation to finish, polling up to 20 times at 100 ms intervals. It errors on an operation error or timeout. With Continue On Fail enabled, a failed item returns {error: message} instead.

Examples

Example 1: Archive a project room once the project is marked complete in an upstream trigger.

Resource: Room; Operation: Archive Room; Room ID in Manual mode with expression {{ $json.roomId }}; Authentication: API Key.

Example 2: Archive a room that a person picks from a list.

Room ID in From List mode, with the room selected from the searchable list.

Links

Discussion