Work Space

Invite to Workspace

POST

Invite a specific user to join a Workspace to which the current user has administrator rights.

A single User may have access to multiple Workspaces, although they can only be logged on to one Workspace at a time. This API lists all Workspaces to which the currently logged on user is entitled to access. To determine which Workspace a user is currently logged on use the /api/data/me endpoint.

This API allows you to invite a specific an invitation to join a specific Workspace.

Path parameters

organizationIdstringRequired
The unique identifier of the Organization that you are inviting a User to joi

Request

This endpoint expects an object.
businessUserId
stringOptional
The unique identifier of the BusinessUser to invite to this Workspace.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
POST
1curl -X POST /api/data/workspaces/organizationId/join \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200
Successful
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue"
12}