Sign in
invitations

Invites a user to a workspace.

<Check title="Required Permissions" icon="key">Allows unauthenticated access.</Check>

post/invitations

Request body

workspaceIdstring uuid nullable

The id of the workspace to invite the user to. If not set, a new workspace will be created.

invitationFlowstring nullable

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.

roleIdstring uuid nullable

The id of the role to which the new user should be added.

connectInviteCodestring nullable

The awork connect invite code.

passcodestring nullable

The bot prevention passcode.

emailstring nullable

The email of the user to be invited.

passwordstring nullable

The Password of the user to be invited.

firstNamestring nullable

The first name of the user to be invited.

lastNamestring nullable

The last name of the user to be invited.

titlestring nullable

The title of the user to be invited.

positionstring nullable

The position of the user to be invited.

genderstring nullable

The gender of the user to be invited. Can be 'male', 'female' or 'other'.

skipSendingEmailboolean

If set to true, skips sending the welcome email. Important for batch invites.

teamIdsstring[] nullable

The list of team ids where the user should be assigned to.

bookedSeatsinteger nullable

The amount of booked seats.

Response

OK

invitationCodestring nullable

The invitation code that is used to confirm the invitation. The code is valid for 24 hours.

passwordResetCodestring nullable

A code that is used to reset the user's password.

userIdstring uuid

The id of the user that has been invited.

Changes

Changed in 1 of the 11 revisions of this API.1