ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

User → Invite User

AI-generated

Summary

Invites a user to the ONLYOFFICE DocSpace portal by email with a chosen account type, then returns the invited user's record looked up by that email.

Inputs

  • Authentication (required) — Credential method used for the API calls: API Key, Basic Auth, OAuth2, or Personal Access Token. The matching credential must be configured.
  • Type (required) — Account type for the invited user: Room Admin (1), DocSpace Admin (3), or User (4, default).
  • Email (required) — Email address of the person to invite.
  • Culture — Language for the invitation, picked from the portal's cultures list or entered manually. Leave empty to use the portal default.

Output shape

One item per input item, containing the user object from the DocSpace people filter (first match for the invited email).

The invite is sent via POST api/2.0/people/invite, then the user is looked up with a separate filter request on email equals. The lookup result is taken as index 0, so it may be undefined if the user isn't found, which raises an error. With Continue On Fail, the item contains {error: message} instead. The culture value is always sent, even when empty.

Examples

Example 1: Onboard a new teammate as a regular user from a form submission.

Type: User; Email: {{ $json.email }}; Culture: empty (portal default).

Example 2: Invite a room admin with a German-language invitation.

Type: Room Admin; Email: admin@example.com; Culture: de.

Links

Discussion