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

Request Body

{
  "share": {
    "emails": "",
    "email_errors": [],
    "join_errors": [],
    "invited_emails": [
      { "first-user@example.com": 5967 },
      { "second-user@example.com": 5977 }
    ],
    "errors": {}
  }
}

Example Request Body

{
  "invitation": {
    "emails": "first-user@example.com, second-user@example.com",
    "role_name": "Creator"
  }
}

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

Last updated