ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Update Room

AI-generated

Summary

Renames an existing ONLYOFFICE DocSpace room by sending a PUT request with the new title, and returns the updated room object.

Inputs

  • Authentication (required) — Credential type used for the request: API Key, Basic Auth, OAuth2 or Personal Access Token. Defaults to API Key.
  • Room ID (required) — The room to update. Pick it from a searchable list of rooms, or enter the numeric ID manually (the manual mode is validated with a regex that checks for digits).
  • Title — The new title for the room. The source always sends this value in the request body, even when it is empty. Unlike the file and folder update operations, it does not skip an empty title, so leaving it blank may send an empty title to the API.

Output shape

One JSON item per input item, containing the updated room object returned by the DocSpace API (the response field of the PUT api/2.0/files/rooms/{roomId} reply).

Title is the only field this operation can change. If a request fails, the node throws an error, unless Continue On Fail is enabled, in which case it outputs an item with an error message.

Examples

Example 1: Rename a project room after a deal closes, using the room ID from a previous node.

Authentication: API Key; Room ID (Manual mode): {{$json.roomId}}; Title: "Acme – Closed Won"

Example 2: Rename a room chosen interactively from the list of rooms.

Room ID: From List (select a room); Title: "Q4 Planning"

Links

Discussion