Invites a user to the workspace.

POST

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

invitationCodestringOptional

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

passwordResetCodestringOptional

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

userIdstringOptional

The id of the user that has been invited.

workspaceobjectOptional

The workspace GET model.

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 '{}'

200Successful

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

Accepts the invitation with the invitation code.

Up Next

Built with

1	curl -X POST https://api.awork.com/api/v1/invitations \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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