Invites a user to the workspace.

POST

1 curl -X POST https://api.awork.com/api/v1/invitations \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
6   "invitationFlow": "invite",
7   "roleId": "123e4567-e89b-12d3-a456-426614174000",
8   "connectInviteCode": null,
9   "email": "carla.creative@ncnstn.com",
10   "password": "AC0mplexP@ssw0rd",
11   "firstName": "Carla",
12   "lastName": "Creative",
13   "title": "Miss",
14   "position": "Creative Director",
15   "gender": "female",
16   "skipSendingEmail": false,
17   "teamIds": [
18     "teamIds"
19   ],
20   "bookedSeats": 25
21 }'

Play

200Successful

1 {
2   "invitationCode": "a368cfdb4=",
3   "passwordResetCode": "f84ab34=",
4   "userId": "123e4567-e89b-12d3-a456-426614174000",
5   "workspace": {
6     "name": "NCNSTN Creative Agency",
7     "description": "We create awesome digital experiences.",
8     "language": "de-DE",
9     "type": "creative-agency",
10     "size": "15",
11     "goals": [
12       "goals"
13     ],
14     "selfAttribution": null,
15     "previousTool": null,
16     "allowSocialLogin": false,
17     "allowCredentialsLogin": false,
18     "allowAutomaticScimUserBooking": null,
19     "sameDomainSignupEnabled": null,
20     "sameDomainSignupRoleId": "123e4567-e89b-12d3-a456-426614174000",
21     "sameDomainSignupDomains": [
22       "sameDomainSignupDomains"
23     ],
24     "skipCreateDefaultWorkspaceData": null,
25     "id": "123e4567-e89b-12d3-a456-426614174000",
26     "subdomains": [
27       {
28         "name": "ncnstn",
29         "isDefault": true
30       }
31     ],
32     "memberCount": 25,
33     "lastUsed": true,
34     "lastLogin": null,
35     "accountIds": [
36       "accountIds"
37     ],
38     "hasImage": true,
39     "createdOn": "createdOn",
40     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
41     "updatedOn": "updatedOn",
42     "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
43     "isTestWorkspace": false,
44     "isApproved": true,
45     "allowSSOLogin": true,
46     "isScimActivated": false,
47     "virtualMRR": null,
48     "isMobileSignup": null,
49     "isFreeMail": null,
50     "isJoinable": false,
51     "isFull": null
52   }
53 }

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.

workspaceIdUUID or nullOptional

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

invitationFlowstring or nullOptional

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.

roleIdUUID or nullOptional

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

connectInviteCodestring or nullOptional

The awork connect invite code.

emailstring or nullOptional

The email of the user to be invited.

passwordstring or nullOptional

The Password of the user to be invited.

firstNamestring or nullOptional

The first name of the user to be invited.

lastNamestring or nullOptional

The last name of the user to be invited.

titlestring or nullOptional

The title of the user to be invited.

positionstring or nullOptional

The position of the user to be invited.

genderstring or nullOptional

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 UUIDsOptional

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

bookedSeatsinteger or nullOptional

The amount of booked seats.

Response

invitationCodestring or nullOptional

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

passwordResetCodestring or nullOptional

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

userIdUUIDOptional

The id of the user that has been invited.

workspaceobjectOptional

The workspace GET model.

Headers

Request

Response