Set workspace access with the Dock API

cURL

curl --request POST \
  --url https://api.dock.us/{version}/workspaces/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceUsers": [
    {
      "role": "owner",
      "user": {
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://dock.us/avatar.png",
        "email": "[email protected]",
        "name": "John Doe"
      }
    }
  ],
  "workspaceDomains": [
    {
      "role": "owner",
      "domain": "dock.us"
    }
  ],
  "notifyPeople": false,
  "message": "You have been added to the workspace"
}
'

{
  "data": {
    "workspace": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "workspaceUsers": [
        {
          "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": "[email protected]",
            "name": "John Doe"
          }
        }
      ],
      "workspaceDomains": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "domain": "dock.us"
        }
      ],
      "account": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "account",
        "url": "https://api.dock.us/v1/accounts/RiHO4e0Ju3DS",
        "name": "Dock",
        "website": "https://dock.us",
        "ownerId": "RiHO4e0Ju3DS",
        "logo": "https://dock.us/logo.png",
        "salesforceAccountId": "0015f00000Bg59dAAB",
        "hubspotCompanyId": "8662045446"
      },
      "object": "workspace",
      "url": "https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS",
      "name": "Customer Onboarding",
      "workspaceUrl": "https://acme.dock.us/customer-onboarding-vRQgIvscHAiO",
      "templateId": "RiHO4e0Ju3DS",
      "startDate": "2024-01-01",
      "targetEndDate": "2024-01-01",
      "actualEndDate": "2024-01-01",
      "projectAge": 100,
      "taskProgress": "50",
      "lastContactView": "2024-01-01T00:00:00Z",
      "totalViews": 100,
      "totalActions": 100,
      "totalTimeSpent": 100,
      "contactsCount": 100,
      "deal": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "hubspotDealId": "1234567890",
        "object": "deal",
        "url": "https://api.dock.us/v1/deals/RiHO4e0Ju3DS",
        "createdDate": "2024-01-01T00:00:00Z",
        "closeDate": "2024-01-01T00:00:00Z",
        "name": "Deal 1",
        "amount": "100000",
        "type": "New Business",
        "stage": "Proposal Sent"
      },
      "customFields": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "customField",
          "url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
          "variableName": "account.name",
          "type": "singleCheckbox",
          "options": [
            {
              "index": 1,
              "label": "Yes",
              "value": "true"
            }
          ],
          "value": "Yes"
        }
      ]
    }
  }
}

POST

workspaces

{id}

access

cURL

curl --request POST \
  --url https://api.dock.us/{version}/workspaces/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceUsers": [
    {
      "role": "owner",
      "user": {
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://dock.us/avatar.png",
        "email": "[email protected]",
        "name": "John Doe"
      }
    }
  ],
  "workspaceDomains": [
    {
      "role": "owner",
      "domain": "dock.us"
    }
  ],
  "notifyPeople": false,
  "message": "You have been added to the workspace"
}
'

{
  "data": {
    "workspace": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "workspaceUsers": [
        {
          "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": "[email protected]",
            "name": "John Doe"
          }
        }
      ],
      "workspaceDomains": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "domain": "dock.us"
        }
      ],
      "account": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "account",
        "url": "https://api.dock.us/v1/accounts/RiHO4e0Ju3DS",
        "name": "Dock",
        "website": "https://dock.us",
        "ownerId": "RiHO4e0Ju3DS",
        "logo": "https://dock.us/logo.png",
        "salesforceAccountId": "0015f00000Bg59dAAB",
        "hubspotCompanyId": "8662045446"
      },
      "object": "workspace",
      "url": "https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS",
      "name": "Customer Onboarding",
      "workspaceUrl": "https://acme.dock.us/customer-onboarding-vRQgIvscHAiO",
      "templateId": "RiHO4e0Ju3DS",
      "startDate": "2024-01-01",
      "targetEndDate": "2024-01-01",
      "actualEndDate": "2024-01-01",
      "projectAge": 100,
      "taskProgress": "50",
      "lastContactView": "2024-01-01T00:00:00Z",
      "totalViews": 100,
      "totalActions": 100,
      "totalTimeSpent": 100,
      "contactsCount": 100,
      "deal": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "hubspotDealId": "1234567890",
        "object": "deal",
        "url": "https://api.dock.us/v1/deals/RiHO4e0Ju3DS",
        "createdDate": "2024-01-01T00:00:00Z",
        "closeDate": "2024-01-01T00:00:00Z",
        "name": "Deal 1",
        "amount": "100000",
        "type": "New Business",
        "stage": "Proposal Sent"
      },
      "customFields": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "customField",
          "url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
          "variableName": "account.name",
          "type": "singleCheckbox",
          "options": [
            {
              "index": 1,
              "label": "Yes",
              "value": "true"
            }
          ],
          "value": "Yes"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

properties

enum<string>[]

Select the workspace properties that should be returned

Available options:

accountId,

name,

workspaceUrl,

templateId,

startDate,

targetEndDate,

actualEndDate,

projectAge,

taskProgress,

lastContactView,

totalViews,

totalActions,

totalTimeSpent,

contactsCount,

account.name,

account.website,

account.ownerId,

account.logo,

account.salesforceAccountId,

account.hubspotCompanyId,

account.createdAt,

account.updatedAt,

customFields.name,

customFields.type,

customFields.variableName,

customFields.value,

workspaceDomains.domain,

workspaceDomains.role,

workspaceDomains.createdAt,

workspaceDomains.updatedAt,

workspaceUsers.role,

workspaceUsers.createdAt,

workspaceUsers.updatedAt,

workspaceUsers.user.firstName,

workspaceUsers.user.lastName,

workspaceUsers.user.avatar,

workspaceUsers.user.email,

workspaceUsers.user.name,

workspaceUsers.user.createdAt,

workspaceUsers.user.updatedAt,

deal.name,

deal.amount,

deal.closeDate,

deal.createdDate,

deal.type,

deal.stage,

deal.hubspotDealId,

deal.salesforceOpportunityId

Body

application/json

Option 1
Option 2

workspaceUsers

object[]

required

Users of the workspace

Show child attributes

workspaceUsers.role

enum<string>

Role of the user to access the workspace

Available options:

owner,

editor,

collaborator,

viewer,

commenter

Example:

"owner"

workspaceUsers.user

object

Show child attributes

workspaceUsers.user.firstName

string | null

First name of the user

Example:

"John"

workspaceUsers.user.lastName

string | null

Last name of the user

Example:

"Doe"

workspaceUsers.user.avatar

string<uri> | null

Avatar of the user

Example:

"https://dock.us/avatar.png"

workspaceUsers.user.email

string

Email of the user

Example:

"[email protected]"

workspaceUsers.user.name

string

Name of the user

Example:

"John Doe"

workspaceDomains

object[]

Domains of the workspace

Show child attributes

workspaceDomains.role

enum<string>

Role of the user to access the workspace

Available options:

owner,

editor,

collaborator,

viewer,

commenter

Example:

"owner"

workspaceDomains.domain

string<hostname>

Domain of the workspace user

Example:

"dock.us"

notifyPeople

boolean

default:false

Notify people for the workspace

message

string

Message to notify people

Example:

"You have been added to the workspace"

Response

Set workspace access

data

object

Show child attributes

data.workspace

object

Show child attributes

data.workspace.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceUsers

object[]

Users of the workspace

Show child attributes

data.workspace.workspaceUsers.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.workspaceUsers.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceUsers.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceUsers.role

enum<string>

Role of the user to access the workspace

Available options:

owner,

editor,

collaborator,

viewer,

commenter

Example:

"owner"

data.workspace.workspaceUsers.user

object

Show child attributes

data.workspace.workspaceUsers.user.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.workspaceUsers.user.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceUsers.user.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceUsers.user.object

enum<string>

Type of the object

Available options:

user

Example:

"user"

data.workspace.workspaceUsers.user.url

string

URL to the resource

Example:

"https://api.dock.us/v1/users/RiHO4e0Ju3DS"

data.workspace.workspaceUsers.user.firstName

string | null

First name of the user

Example:

"John"

data.workspace.workspaceUsers.user.lastName

string | null

Last name of the user

Example:

"Doe"

data.workspace.workspaceUsers.user.avatar

string<uri> | null

Avatar of the user

Example:

"https://dock.us/avatar.png"

data.workspace.workspaceUsers.user.email

string

Email of the user

Example:

"[email protected]"

data.workspace.workspaceUsers.user.name

string

Name of the user

Example:

"John Doe"

data.workspace.workspaceDomains

object[]

Domains of the workspace

Show child attributes

data.workspace.workspaceDomains.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.workspaceDomains.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceDomains.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.workspaceDomains.role

enum<string>

Role of the user to access the workspace

Available options:

owner,

editor,

collaborator,

viewer,

commenter

Example:

"owner"

data.workspace.workspaceDomains.domain

string<hostname>

Domain of the workspace user

Example:

"dock.us"

data.workspace.account

object

Show child attributes

data.workspace.account.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.account.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.account.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.account.object

enum<string>

Type of the object

Available options:

account

Example:

"account"

data.workspace.account.url

string

URL to the resource

Example:

"https://api.dock.us/v1/accounts/RiHO4e0Ju3DS"

data.workspace.account.name

string

Name of the account

Example:

"Dock"

data.workspace.account.website

string<uri> | null

Website of the account

Example:

"https://dock.us"

data.workspace.account.ownerId

string

Owner ID of the account

Example:

"RiHO4e0Ju3DS"

data.workspace.account.logo

string<uri> | null

Logo of the account

Example:

"https://dock.us/logo.png"

data.workspace.account.salesforceAccountId

string | null

Salesforce account ID of the account

Example:

"0015f00000Bg59dAAB"

data.workspace.account.hubspotCompanyId

string | null

HubSpot company ID of the account

Example:

"8662045446"

data.workspace.object

enum<string>

Type of the object

Available options:

workspace

Example:

"workspace"

data.workspace.url

string

URL to the resource

Example:

"https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS"

data.workspace.name

string

Name of the workspace

Example:

"Customer Onboarding"

data.workspace.workspaceUrl

string

URL of the workspace

Example:

"https://acme.dock.us/customer-onboarding-vRQgIvscHAiO"

data.workspace.templateId

string | null

ID of the associated template

Example:

"RiHO4e0Ju3DS"

data.workspace.startDate

string<date> | null

Start date of the workspace

Example:

"2024-01-01"

data.workspace.targetEndDate

string<date> | null

Target end date of the workspace

Example:

"2024-01-01"

data.workspace.actualEndDate

string<date> | null

Actual end date of the workspace

Example:

"2024-01-01"

data.workspace.projectAge

number

Age of the project

Example:

100

data.workspace.taskProgress

string

Progress of all the tasks

Example:

"50"

data.workspace.lastContactView

string<date-time> | null

Last contact view date of the workspace

Example:

"2024-01-01T00:00:00Z"

data.workspace.totalViews

number

Total views of the workspace

Example:

100

data.workspace.totalActions

number

Total actions of the workspace

Example:

100

data.workspace.totalTimeSpent

number

Total time spent of the workspace

Example:

100

data.workspace.contactsCount

number

Number of contacts associated with the workspace

Example:

100

data.workspace.deal

object

Option 1
Option 2

Show child attributes

data.workspace.deal.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.deal.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.deal.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.deal.hubspotDealId

string | null

HubSpot deal ID

Example:

"1234567890"

data.workspace.deal.object

enum<string>

Type of the object

Available options:

deal

Example:

"deal"

data.workspace.deal.url

string

URL to the resource

Example:

"https://api.dock.us/v1/deals/RiHO4e0Ju3DS"

data.workspace.deal.createdDate

string<date-time> | null

Created date of the deal

Example:

"2024-01-01T00:00:00Z"

data.workspace.deal.closeDate

string<date-time> | null

Close date of the deal

Example:

"2024-01-01T00:00:00Z"

data.workspace.deal.name

string | null

Name of the deal

Example:

"Deal 1"

data.workspace.deal.amount

integer | null

Amount of the deal

Example:

"100000"

data.workspace.deal.type

string | null

Type of the deal

Example:

"New Business"

data.workspace.deal.stage

string | null

Stage of the deal

Example:

"Proposal Sent"

data.workspace.customFields

object[]

Custom fields associated with the workspace

Show child attributes

data.workspace.customFields.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspace.customFields.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.customFields.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspace.customFields.object

enum<string>

Type of the object

Available options:

customField

Example:

"customField"

data.workspace.customFields.url

string

URL to the resource

Example:

"https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS"

data.workspace.customFields.variableName

string

Variable name of the custom field

Example:

"account.name"

data.workspace.customFields.type

enum<string>

Type of the custom field

Available options:

number,

date,

singleLineText,

multiLineText,

singleCheckbox,

multiCheckboxes,

dropdownSelect,

radioSelect

Example:

"singleCheckbox"

data.workspace.customFields.options

object[] | null

For dropdown, radio, and checkbox custom fields, the options

Show child attributes

data.workspace.customFields.options.index

integer

Index of the option

Example:

1

data.workspace.customFields.options.label

string

Label of the option

Example:

"Yes"

data.workspace.customFields.options.value

string

Value of the option

Example:

"true"

data.workspace.customFields.value

string

Value of the custom field

Example:

"Yes"

Create a workspace Update a workspace

⌘I

API Reference

Status Check

Accounts

Deals

Users

Templates

Workspaces

Workspace users

Workspace domains

Workspace pages

Workspace sections

Workspace plans

Workspace plan tasks

Custom fields

Assets

Tags

Boards

Set workspace access

Authorizations

Path Parameters

Query Parameters

Body

Response