ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Invite User

AI-generated

Summary

Invites an existing user (by ID) or any person (by email) to an ONLYOFFICE DocSpace room with a chosen access level, optionally sending a notification, and returns the resulting room member record.

Inputs

  • authentication (required) — Credential type: API Key, Basic Auth, OAuth2 or Personal Access Token. Selects which DocSpace credentials (and base URL) are used.
  • roomId (required) — Room to invite the user to. Pick from a searchable list or enter a numeric ID manually.
  • userId (required) — ID of an existing user to invite, chosen from the list of users not yet in the room or entered manually. Hidden when User Email is set. Provide this or User Email, not both.
  • userEmail (required) — Email of the person to invite. Hidden when User ID is set. If no such user exists, DocSpace creates a guest user.
  • userAccess (required) — Access level to grant. The list is filtered by the room's type. Options are Viewer (2), Reviewer (5), Commenter (6), Form Filler (7), Room Manager (9, paid), Editor (10) and Content Creator (11). A manual numeric value is also accepted.
  • notify (required) — Whether DocSpace sends the user an invitation notification. Defaults to true.
  • culture — Language for the invitation. Shown only when Notify is true. If empty, the portal default language is used.

Output shape

One JSON item per input item, describing the invited user's share/membership record in the room (access level and the user in sharedTo).

If you invite by user ID, the output is the first entry of members from the share response. If you invite by email, the node makes a second request to the room's share list, filtered by that email, and returns the first match. The node errors if neither or both of User ID and User Email are provided. With Continue On Fail enabled, a failed item returns {error: message}.

Examples

Example 1: Add an existing teammate to a collaboration room as an editor, with a notification.

Room ID: pick from list; User ID: pick from list; User Access: Editor; Notify: true

Example 2: Invite an external client by email as a viewer, in French.

Room ID: 12345 (manual); User Email: client@example.com; User Access: Viewer; Notify: true; Culture: fr

Example 3: Silently grant access to a person coming from an upstream node.

Room ID: expression; User Email: {{$json.email}}; User Access: Content Creator; Notify: false

Links

Discussion