Invite users to a workspace.

Invite users to a workspace. All invited users will have the same defined permission.

Path Parameters

organization_id integer required
ID of the workspace

application/json

Request Body required

role string required
Possible values: [USER, VIEWER, ANNOTATOR, ADMIN, MANAGER]
User's role
emails email[] required
List of emails

Responses

User invited to the workspace.

application/json

Schema
Example (from schema)

Schema

not_invited object[]
List of users that were not invited
email email
Invited email
reason string
The reason why invitation failed
invitations object[]
List of invitations sent
id integer
The ID of the invitation
role string
Possible values: [USER, VIEWER, ANNOTATOR, ADMIN, MANAGER]
User's role
email email
Invited email
invited_by_id integer
ID of the user who sent the invitation
organization_id integer
ID of the organization
created date-time
invitation date
invitation_link string
The invitation link. This link contains an invitation token

{
  "not_invited": [
    {
      "email": "user@example.com",
      "reason": "User was already invited"
    }
  ],
  "invitations": [
    {
      "id": 5,
      "role": "USER",
      "email": "user@example.com",
      "invited_by_id": 5,
      "organization_id": 1,
      "created": "2023-11-02",
      "invitation_link": "string"
    }
  ]
}

Invite users to a workspace.​

Invite users to a workspace.