API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Workspace users
Create a workspace user
Create a workspace user
POST
/
workspace-users
Copy
Ask AI
curl --request POST \
--url https://api.dock.us/{version}/workspace-users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "john.doe@example.com",
"role": "owner",
"workspaceId": "luI89ZCeEJuF",
"message": "You have been invited to join the workspace"
}'
Copy
Ask AI
{
"data": {
"workspaceUser": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"role": "owner",
"user": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "user",
"url": "https://api.dock.us/v1/users/RiHO4e0Ju3DS",
"firstName": "John",
"lastName": "Doe",
"avatar": "https://dock.us/avatar.png",
"email": "john.doe@example.com",
"name": "John Doe"
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select the workspace user properties that should be returned
Body
application/json
Workspace user to create
The body is of type object
.
Response
200
application/json
Create a workspace user
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.dock.us/{version}/workspace-users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "john.doe@example.com",
"role": "owner",
"workspaceId": "luI89ZCeEJuF",
"message": "You have been invited to join the workspace"
}'
Copy
Ask AI
{
"data": {
"workspaceUser": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"role": "owner",
"user": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "user",
"url": "https://api.dock.us/v1/users/RiHO4e0Ju3DS",
"firstName": "John",
"lastName": "Doe",
"avatar": "https://dock.us/avatar.png",
"email": "john.doe@example.com",
"name": "John Doe"
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.