Invite user to path

You can invite someone to a path. The invited user will need to accept this invite before the user is actually added.

A user can be invited by his or her userId or email. If no user exists for the given email adres, an email is sent to the given adres. This email contains a link that will help the invited user to setup his or her account.

Description

Invite user to access a block or a folder.

Endpoint

/path/{pathId}/invite

Method

POST

Access Level Rules

Access Level

edit+ or canShare

Processing Units

Processing units

0

Parameters

NameDescriptionRequiredDefault

pathId

The id of the path or folder to share.

true

userId

The id of the user to share the block /folder with.

If no email is given

email

The email to sent the invite to

If no userId is given

access

Object with properties canShare, geoFence, monthlyFee, accessLevel and processingUnits defining the access given to the user. geoFence should be an object with tiles and maxZoom. Tiles should be an array of objects with tileX, tileY and zoom.

true

sendMail

Boolean whether an invite email should be sent when inviting an existing user.

false

Default true.

Last updated