Invite user to path
You can invite someone to a path to provide them with custom access to its content. The invited user needs to accept this invite to starting using the new access.
A user can be invited by their userId and email. When inviting a user through their email, an email is sent to the given address if no user with that email exists yet. This email contains a link that will help the invited user setup their account.
Description
Invite user to access a path.
Endpoint
/path/{pathId}/invite
Method
POST
Access Level Rules
Access Level
share and the same access as is included in the invitation
Processing Units
Processing units
2
Parameters
pathId
The id of the path to share.
true
userId
The id of the user to share the path with.
Required if no email is given.
email
The email of the user to share the path with.
Required if no userId is given.
access
An access Object with properties "geoFence", "monthlyFee", "accessTier" and "processingUnits" defining the access given to the user. "accessTier" needs to be one of 'view', 'view+', 'share', 'edit', 'edit+' or 'admin'
true
sendMail
Boolean whether an invite email should be sent when inviting an existing user.
false
Default true.
Last updated