ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Update User

AI-generated

Summary

Changes the access level of an existing user in an ONLYOFFICE DocSpace room, identifying the user by ID or by email, and returns the updated room member record.

Inputs

  • authentication (required) — Credential type used for the request: API Key, Basic Auth, OAuth2, or Personal Access Token.
  • roomId (required) — Room containing the user. Pick from a searchable list of rooms or enter a numeric ID manually.
  • userId (required) — User to update. Pick from the room's current members or enter an ID manually. Hidden when User Email is set. Use this or User Email, not both.
  • userEmail (required) — Email of the user to update. Hidden when User ID is set. Use this or User ID, not both.
  • userAccess (required) — Access level to assign. The list is filtered by the room type: Viewer (2), Reviewer (5), Commenter (6), Form Filler (7), Room Manager (9), Editor (10), Content Creator (11). Manual entry takes the numeric value.

Output shape

One item per input item, containing the room member record for the updated user. It includes the user's access and shared-to details as returned by the DocSpace API.

If you identify the user by ID, the record is the first member in the share response. If you identify the user by email, the node makes a second request to the room's share list, filtered by that email, and returns the first match. It errors if neither or both of User ID and User Email are supplied. With Continue On Fail enabled, a failed item returns an object with an error message instead.

Examples

Example 1: Promote a room member to Editor by selecting them from the list.

Room ID: from list; User ID: from list; User Access: Editor.

Example 2: Downgrade a user to Viewer using an email from an earlier workflow step.

Room ID: manual numeric ID; User Email: {{ $json.email }}; User ID left empty; User Access: Viewer.

Links

Discussion