Skip to main content
POST
/
workspace-domains
cURL
curl --request POST \
  --url https://api.dock.us/{version}/workspace-domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "example.com",
  "role": "owner",
  "workspaceId": "luI89ZCeEJuF"
}
'
{
  "data": {
    "workspaceDomain": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "role": "owner",
      "domain": "dock.us"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
properties
enum<string>[]

Select the workspace domain properties that should be returned

Available options:
role,
domain,
createdAt,
updatedAt

Body

application/json

Workspace domain to create

​
domain
string
required

Domain to create

Example:

"example.com"

​
role
enum<string>
required

Role of the user to access the workspace

Available options:
owner,
editor,
collaborator,
viewer,
commenter
Example:

"owner"

​
workspaceId
string
required

ID of the workspace

Example:

"luI89ZCeEJuF"

Response

Workspace domain created

​
data
object