Sign in
Workspace

Invite Workspace Users

Invites users to a workspace by email.

post/api/v1/workspaces/{workspace_id}/users/invite

Path parameters

workspace_idinteger required

ID of the workspace

Example:123456

Request body

email_liststring[] nullable

List of user emails to invite to the workspace.

role'ADMIN' | 'MEMBER' | 'GUEST'

Role of the user inside the workspace

Example request

{
  "email_list": [
    "teammate@example.com"
  ]
}

Response

Successful Response

invited_emailsstring[] required

Emails successfully invited to the workspace.

Example response

{
  "invited_emails": [
    "teammate@example.com"
  ]
}

Changes

No recorded changes to this endpoint across all 10 revisions of this API.