Invitations
Last updated
Was this helpful?
Last updated
Was this helpful?
Invitations are placeholders for objects. You cannot create a rolemap directly because, sometimes, user approval is required. Invitations are sent to users via email and, once accepted, create a rolemap on the object they were invited to with the requested .
POST
https://ws-api.onehub.com/:item/:id/invitations
Create an invitation to the :item
(Workspace, folder, or file) specified via :id
.
:item
string
The type of item. Can be workspaces
, folders
, or files
.
:id
integer
The unique identifier of the item you would like to create an invitation to.
invitation
object
This is the top level object that contains the emails
and role_name
keys described below.
emails
string
The email addresses you would like to invite to the item. Multiple email addresses should be comma delimited in a single string.
role_name
string
The effective role granted to the user(s).
If a role_name
is not provided, or is invalid, the will be used.