Invites the user with the email address to the workspace with the specified id.
Sends an invitation email to the user with a link to accept the invitation.
For automated invitation flows, sending the email can be skipped by setting the
'skipSendingEmail' flag to 'true'.
Additionally, the invitation code, which is valid for 24 hours,
is returned so that the caller can accept the invitation right away.
Request
This endpoint expects an object.
workspaceIdstringOptional
The id of the workspace to invite the user to.
If not set, a new workspace will be created.
planIdstringOptional
The selected plan of the workspace.
Only allowed when creating a new workspace.
Defaults to the free plan.
invitationFlowstringOptional
The current invitation flow.
Use ‘invite’ for an invitation from a system admin,
‘new_user_new_workspace’ for an invitation when creating a workspace for a new user or
‘existing_user_new_workspace’ when creating a workspace for an existing user.
roleIdstringOptional
The id of the role to which the new user should be added.
connectInviteCodestringOptional
The awork connect invite code.
emailstringOptional
The email of the user to be invited.
passwordstringOptional
The Password of the user to be invited.
firstNamestringOptional
The first name of the user to be invited.
lastNamestringOptional
The last name of the user to be invited.
titlestringOptional
The title of the user to be invited.
positionstringOptional
The position of the user to be invited.
genderstringOptional
The gender of the user to be invited. Can be 'male', 'female' or 'other'.
skipSendingEmailbooleanOptional
If set to true, skips sending the welcome email. Important for batch invites.
teamIdslist of stringsOptional
The list of team ids where the user should be assigned to.
bookedSeatsintegerOptional
The amount of booked seats.
Response
This endpoint returns an object
invitationCodestringOptional
The invitation code that is used to confirm the invitation.
The code is valid for 24 hours.