Invitations

Invitations are placeholders for rolemap 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 role.

Create an Invitation

POST https://ws-api.onehub.com/:item/:id/invitations

Create an invitation to the :item (Workspace, folder, or file) specified via :id.

Path Parameters

Name	Type	Description
: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.

Request Body

Name	Type	Description
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).

201 Returns a share object and a 201 if the call succeeds.

{
  "share": {
    "emails": "",
    "email_errors": [],
    "join_errors": [],
    "invited_emails": [
      { "[email protected]": 5967 },
      { "[email protected]": 5977 }
    ],
    "errors": {}
  }
}

422 Returns a 422 with an error in the message body if an invalid email is provided or if a limit is reached.

//

Example Request Body

{
  "invitation": {
    "emails": "[email protected], [email protected]",
    "role_name": "Creator"
  }
}

If a role_name is not provided, or is invalid, the default role will be used.