{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "The server has encountered a situation it does not know how to handle"
}
}
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
required
Unique identifier
Example:
"RiHO4e0Ju3DS"
Query Parameters
properties
enum<string>[]
Select the workspace properties that should be returned
Available options:
account.id,
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,
id,
object,
url,
createdAt,
updatedAt,
workspaceDomains.id,
workspaceDomains.object,
workspaceDomains.url,
workspaceUsers.id,
workspaceUsers.object,
workspaceUsers.url,
workspaceUsers.user.id,
workspaceUsers.user.object,
workspaceUsers.user.url,
account.object,
account.url,
account.customFields.id,
account.customFields.object,
account.customFields.url,
account.customFields.createdAt,
account.customFields.updatedAt,
account.customFields.name,
account.customFields.variableName,
account.customFields.objectType,
account.customFields.type,
account.customFields.options.index,
account.customFields.options.label,
account.customFields.options.value,
account.customFields.value,
deal.id,
deal.object,
deal.url,
deal.createdAt,
deal.updatedAt,
deal.customFields.id,
deal.customFields.object,
deal.customFields.url,
deal.customFields.createdAt,
deal.customFields.updatedAt,
deal.customFields.name,
deal.customFields.variableName,
deal.customFields.objectType,
deal.customFields.type,
deal.customFields.options.index,
deal.customFields.options.label,
deal.customFields.options.value,
deal.customFields.value,
customFields.id,
customFields.object,
customFields.url,
customFields.createdAt,
customFields.updatedAt,
customFields.objectType,
customFields.options.index,
customFields.options.label,
customFields.options.value
Body
application/json
Option 1
Option 2
workspaceUsers
object[]
required
Users of the workspace. Supplying this array replaces the workspace's entire user list — include every user who should have access, as existing users omitted from the array are removed from the workspace.
Domains of the workspace. Supplying this array replaces the workspace's entire domain list — include every domain that should have access, as existing domains omitted from the array are removed from the workspace.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Dock","colors":{"primary":"#4058FF","light":"#4984EB","dark":"#4058FF"},"favicon":"https://mintcdn.com/docklabsinc/pUYB1Rr4_wf6-EkO/favicon.svg?fit=max\u0026auto=format\u0026n=pUYB1Rr4_wf6-EkO\u0026q=85\u0026s=3834c2cccaa90659d26b91bd3aec0acf","logo":{"light":"https://mintcdn.com/docklabsinc/pUYB1Rr4_wf6-EkO/logo/light.svg?fit=max\u0026auto=format\u0026n=pUYB1Rr4_wf6-EkO\u0026q=85\u0026s=8d3b9704bcec3086906fe18017582e75","dark":"https://mintcdn.com/docklabsinc/pUYB1Rr4_wf6-EkO/logo/dark.svg?fit=max\u0026auto=format\u0026n=pUYB1Rr4_wf6-EkO\u0026q=85\u0026s=8b39fd5e516073e4e2b131c298a28cc0"},"api":{"openapi":"api-reference/openapi.json"},"background":{"decoration":"gradient"},"footer":{"socials":{"x":"https://x.com/dock_us","linkedin":"https://www.linkedin.com/company/dock-us"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"docklabsinc","hasAudioNarration":false,"actualSubdomain":"docklabsinc","customDomains":["developers.dock.us"],"gitSource":{"type":"github","owner":"dock-hq","repo":"dock","deployBranch":"production","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afba5647c4d8aaf2a2c45e6","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":94},{"language":"default","tag":"Workspaces","count":57},{"language":"default","tag":"Library","count":12},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Clients","count":9},{"language":"default","tag":"Tasks","count":8},{"language":"default","tag":"Learning","count":7},{"language":"default","tag":"Users","count":7},{"language":"default","tag":"API Reference","count":7},{"language":"default","tag":"Assets","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/workspaces/set-workspace-access","slug":"/api-reference/endpoint/workspaces/set-workspace-access","pageMetadata":{"title":"Set workspace access","openapi":"post /workspaces/{id}/access","og:title":"Set workspace access with the Dock API - API Reference","description":"Set workspace access","href":"/api-reference/endpoint/workspaces/set-workspace-access"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Set workspace access\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const RateLimit=({perMinute=120})=>{const _components={a:`a`,..._provideComponents()},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[`This endpoint is rate limited to`,` `,_jsxs(`strong`,{children:[perMinute,` requests per minute`]}),` per company. See`,` `,_jsx(_components.a,{href:`/api-reference/rate-limits`,children:`Rate limits`}),` for details.`]})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`RateLimit`,children:_jsx(RateLimit,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{RateLimit,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Set workspace access","openapi":"post /workspaces/{id}/access","og:title":"Set workspace access with the Dock API - API Reference","description":"Set workspace access","href":"/api-reference/endpoint/workspaces/set-workspace-access"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[126,522,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Set workspace access","tags":["Workspaces"],"parameters":["a11f81d5-bf62-4da1-8d4e-36e23d57845f","52db0447-10c3-47db-875a-2d5e5e2c0771"],"requestBody":"8c99c751-e0f3-4b2d-91bf-6706036a040c","responses":{"200":"9a05b8ce-e65f-477a-ac6a-fd8a51ec3085","400":"f40da9ab-dc08-41c4-ace8-1d4a2b00cbe3","401":"3fce4217-5aa8-4a35-a804-bf126300729a","403":"9d5527be-5c8c-4fdb-9381-47acd8ab9e68","404":"a5ad0d8f-f7be-49b7-8e52-037af274be66","429":"768011fc-1cdc-4a77-aa03-dceb566808b2","500":"061a70ee-359d-4bfe-b7be-6552a5990145"},"method":"post","type":"path","servers":["c55415d5-f416-4bba-a736-32deabe53fe8"],"security":["9f6d0c1a-fd03-4cea-8c0f-f40ae485abf3"],"path":"/workspaces/{id}/access","baseUrlOptions":["https://api.dock.us/{version}"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a11f81d5-bf62-4da1-8d4e-36e23d57845f":{"name":"id","in":"path","example":"RiHO4e0Ju3DS","required":true,"description":"Unique identifier","schema":{"type":"string","example":"RiHO4e0Ju3DS","isRequired":true,"description":"Unique identifier","uniqueKey":"","typeLabel":"string"}},"52db0447-10c3-47db-875a-2d5e5e2c0771":{"name":"properties","in":"query","description":"Select the workspace properties that should be returned","schema":{"type":"array","items":{"type":"string","enum":["account.id","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","id","object","url","createdAt","updatedAt","workspaceDomains.id","workspaceDomains.object","workspaceDomains.url","workspaceUsers.id","workspaceUsers.object","workspaceUsers.url","workspaceUsers.user.id","workspaceUsers.user.object","workspaceUsers.user.url","account.object","account.url","account.customFields.id","account.customFields.object","account.customFields.url","account.customFields.createdAt","account.customFields.updatedAt","account.customFields.name","account.customFields.variableName","account.customFields.objectType","account.customFields.type","account.customFields.options.index","account.customFields.options.label","account.customFields.options.value","account.customFields.value","deal.id","deal.object","deal.url","deal.createdAt","deal.updatedAt","deal.customFields.id","deal.customFields.object","deal.customFields.url","deal.customFields.createdAt","deal.customFields.updatedAt","deal.customFields.name","deal.customFields.variableName","deal.customFields.objectType","deal.customFields.type","deal.customFields.options.index","deal.customFields.options.label","deal.customFields.options.value","deal.customFields.value","customFields.id","customFields.object","customFields.url","customFields.createdAt","customFields.updatedAt","customFields.objectType","customFields.options.index","customFields.options.label","customFields.options.value"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Select the workspace properties that should be returned","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["workspaceUsers"],"properties":{"workspaceUsers":{"type":"array","description":"Users of the workspace. Supplying this array replaces the workspace's entire user list — include every user who should have access, as existing users omitted from the array are removed from the workspace.","items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"user":{"type":"object","properties":{"firstName":{"oneOf":[{"type":"string","description":"First name of the user","example":"John","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the user","example":"John","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the user","example":"Doe","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the user","example":"Doe","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.lastName","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.avatar.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.avatar","typeLabel":"string\u003curi> | null"},"email":{"type":"string","description":"Email of the user","example":"john.doe@example.com","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.email","typeLabel":"string"},"name":{"type":"string","description":"Name of the user","example":"John Doe","uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user.name","typeLabel":"string"}},"uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX].user","typeLabel":"object"}},"uniqueKey":"oneOf.0.workspaceUsers.items.[INDEX]","typeLabel":"object"},"example":[{"email":"jane@acme.com","role":"owner"},{"email":"sam@acme.com","role":"viewer"}],"isRequired":true,"uniqueKey":"oneOf.0.workspaceUsers","typeLabel":"object[]"},"workspaceDomains":{"type":"array","description":"Domains of the workspace. Supplying this array replaces the workspace's entire domain list — include every domain that should have access, as existing domains omitted from the array are removed from the workspace.","items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"oneOf.0.workspaceDomains.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"domain":{"type":"string","description":"Domain of the workspace user","format":"hostname","example":"dock.us","uniqueKey":"oneOf.0.workspaceDomains.items.[INDEX].domain","typeLabel":"string\u003chostname>"}},"uniqueKey":"oneOf.0.workspaceDomains.items.[INDEX]","typeLabel":"object"},"example":[{"domain":"acme.com","role":"collaborator"}],"uniqueKey":"oneOf.0.workspaceDomains","typeLabel":"object[]"},"notifyPeople":{"type":"boolean","description":"Notify people for the workspace","default":false,"uniqueKey":"oneOf.0.notifyPeople","typeLabel":"boolean"},"message":{"type":"string","description":"Message to notify people","example":"You have been added to the workspace","uniqueKey":"oneOf.0.message","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["workspaceDomains"],"properties":{"workspaceDomains":{"type":"array","description":"Domains of the workspace. Supplying this array replaces the workspace's entire domain list — include every domain that should have access, as existing domains omitted from the array are removed from the workspace.","items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"oneOf.1.workspaceDomains.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"domain":{"type":"string","description":"Domain of the workspace user","format":"hostname","example":"dock.us","uniqueKey":"oneOf.1.workspaceDomains.items.[INDEX].domain","typeLabel":"string\u003chostname>"}},"uniqueKey":"oneOf.1.workspaceDomains.items.[INDEX]","typeLabel":"object"},"example":[{"domain":"acme.com","role":"collaborator"}],"isRequired":true,"uniqueKey":"oneOf.1.workspaceDomains","typeLabel":"object[]"},"workspaceUsers":{"type":"array","description":"Users of the workspace. Supplying this array replaces the workspace's entire user list — include every user who should have access, as existing users omitted from the array are removed from the workspace.","items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"user":{"type":"object","properties":{"firstName":{"oneOf":[{"type":"string","description":"First name of the user","example":"John","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the user","example":"John","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the user","example":"Doe","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the user","example":"Doe","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.lastName","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.avatar.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.avatar","typeLabel":"string\u003curi> | null"},"email":{"type":"string","description":"Email of the user","example":"john.doe@example.com","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.email","typeLabel":"string"},"name":{"type":"string","description":"Name of the user","example":"John Doe","uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user.name","typeLabel":"string"}},"uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX].user","typeLabel":"object"}},"uniqueKey":"oneOf.1.workspaceUsers.items.[INDEX]","typeLabel":"object"},"example":[{"email":"jane@acme.com","role":"owner"},{"email":"sam@acme.com","role":"viewer"}],"uniqueKey":"oneOf.1.workspaceUsers","typeLabel":"object[]"},"notifyPeople":{"type":"boolean","description":"Notify people for the workspace","default":false,"uniqueKey":"oneOf.1.notifyPeople","typeLabel":"boolean"},"message":{"type":"string","description":"Message to notify people","example":"You have been added to the workspace","uniqueKey":"oneOf.1.message","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"workspaceUsers":[{"email":"jane@acme.com","role":"owner"},{"email":"sam@acme.com","role":"viewer"}],"workspaceDomains":[{"domain":"acme.com","role":"collaborator"}],"notifyPeople":false,"message":"You have been added to the workspace"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9a05b8ce-e65f-477a-ac6a-fd8a51ec3085":{"description":"Set workspace access","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.createdAt","typeLabel":"string\u003cdate-time>"},"workspaceUsers":{"type":"array","description":"Users of the workspace","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","description":"Type of the object","enum":["workspace-user"],"example":"workspace-user","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/workspace-users/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].url","typeLabel":"string"},"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"user":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.createdAt","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","description":"Type of the object","enum":["user"],"example":"user","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/users/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.url","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"First name of the user","example":"John","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the user","example":"John","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the user","example":"Doe","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the user","example":"Doe","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.lastName","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.avatar.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Avatar of the user","example":"https://dock.us/avatar.png","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.avatar","typeLabel":"string\u003curi> | null"},"email":{"type":"string","description":"Email of the user","example":"john.doe@example.com","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.email","typeLabel":"string"},"name":{"type":"string","description":"Name of the user","example":"John Doe","uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user.name","typeLabel":"string"}},"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX].user","typeLabel":"object"}},"uniqueKey":"data.workspace.workspaceUsers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.workspace.workspaceUsers","typeLabel":"object[]"},"workspaceDomains":{"type":"array","description":"Domains of the workspace","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","description":"Type of the object","enum":["workspace-domain"],"example":"workspace-domain","readOnly":true,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/workspace-domains/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].url","typeLabel":"string"},"role":{"type":"string","description":"Role of the user to access the workspace","enum":["owner","editor","collaborator","viewer","commenter"],"example":"owner","uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"domain":{"type":"string","description":"Domain of the workspace user","format":"hostname","example":"dock.us","uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].domain","typeLabel":"string\u003chostname>"}},"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.workspace.workspaceDomains","typeLabel":"object[]"},"account":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.account.id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.account.updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.account.createdAt","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","description":"Type of the object","enum":["account"],"example":"account","readOnly":true,"uniqueKey":"data.workspace.account.object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/accounts/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.account.url","typeLabel":"string"},"name":{"type":"string","description":"Name of the account","example":"Dock","uniqueKey":"data.workspace.account.name","typeLabel":"string"},"website":{"oneOf":[{"type":"string","format":"uri","description":"Website of the account","example":"https://dock.us","uniqueKey":"data.workspace.account.website.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Website of the account","example":"https://dock.us","uniqueKey":"data.workspace.account.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.account.website","typeLabel":"string\u003curi> | null"},"ownerId":{"type":"string","description":"Owner ID of the account","example":"RiHO4e0Ju3DS","uniqueKey":"data.workspace.account.ownerId","typeLabel":"string"},"logo":{"oneOf":[{"type":"string","format":"uri","description":"Logo of the account","example":"https://dock.us/logo.png","uniqueKey":"data.workspace.account.logo.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Logo of the account","example":"https://dock.us/logo.png","uniqueKey":"data.workspace.account.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.account.logo","typeLabel":"string\u003curi> | null"},"salesforceAccountId":{"oneOf":[{"type":"string","description":"Salesforce account ID of the account","example":"0015f00000Bg59dAAB","uniqueKey":"data.workspace.account.salesforceAccountId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salesforce account ID of the account","example":"0015f00000Bg59dAAB","uniqueKey":"data.workspace.account.salesforceAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.account.salesforceAccountId","typeLabel":"string | null"},"hubspotCompanyId":{"oneOf":[{"type":"string","description":"HubSpot company ID of the account","example":"8662045446","uniqueKey":"data.workspace.account.hubspotCompanyId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HubSpot company ID of the account","example":"8662045446","uniqueKey":"data.workspace.account.hubspotCompanyId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.account.hubspotCompanyId","typeLabel":"string | null"}},"uniqueKey":"data.workspace.account","typeLabel":"object"},"object":{"type":"string","description":"Type of the object","enum":["workspace"],"example":"workspace","readOnly":true,"uniqueKey":"data.workspace.object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.url","typeLabel":"string"},"name":{"type":"string","description":"Name of the workspace","example":"Customer Onboarding","uniqueKey":"data.workspace.name","typeLabel":"string"},"workspaceUrl":{"type":"string","description":"URL of the workspace","example":"https://acme.dock.us/customer-onboarding-vRQgIvscHAiO","uniqueKey":"data.workspace.workspaceUrl","typeLabel":"string"},"templateId":{"oneOf":[{"type":"string","description":"ID of the associated template","example":"RiHO4e0Ju3DS","uniqueKey":"data.workspace.templateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the associated template","example":"RiHO4e0Ju3DS","uniqueKey":"data.workspace.templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.templateId","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","format":"date","description":"Start date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.startDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Start date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.startDate","typeLabel":"string\u003cdate> | null"},"targetEndDate":{"oneOf":[{"type":"string","format":"date","description":"Target end date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.targetEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Target end date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.targetEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.targetEndDate","typeLabel":"string\u003cdate> | null"},"actualEndDate":{"oneOf":[{"type":"string","format":"date","description":"Actual end date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.actualEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Actual end date of the workspace","example":"2024-01-01","uniqueKey":"data.workspace.actualEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.actualEndDate","typeLabel":"string\u003cdate> | null"},"projectAge":{"type":"number","description":"Age of the project","example":100,"uniqueKey":"data.workspace.projectAge","typeLabel":"number"},"taskProgress":{"type":"string","description":"Progress of all the tasks","example":"50","uniqueKey":"data.workspace.taskProgress","typeLabel":"string"},"lastContactView":{"oneOf":[{"type":"string","format":"date-time","description":"Last contact view date of the workspace","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.lastContactView.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last contact view date of the workspace","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.lastContactView.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.lastContactView","typeLabel":"string\u003cdate-time> | null"},"totalViews":{"type":"number","description":"Total views of the workspace","example":100,"uniqueKey":"data.workspace.totalViews","typeLabel":"number"},"totalActions":{"type":"number","description":"Total actions of the workspace","example":100,"uniqueKey":"data.workspace.totalActions","typeLabel":"number"},"totalTimeSpent":{"type":"number","description":"Total time spent of the workspace","example":100,"uniqueKey":"data.workspace.totalTimeSpent","typeLabel":"number"},"contactsCount":{"type":"number","description":"Number of contacts associated with the workspace","example":100,"uniqueKey":"data.workspace.contactsCount","typeLabel":"number"},"deal":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.0.id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"hubspotDealId":{"oneOf":[{"type":"string","description":"HubSpot deal ID","example":"1234567890","uniqueKey":"data.workspace.deal.oneOf.0.hubspotDealId.oneOf.0","typeLabel":"string"},{"type":"null","description":"HubSpot deal ID","example":"1234567890","uniqueKey":"data.workspace.deal.oneOf.0.hubspotDealId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.hubspotDealId","typeLabel":"string | null"},"object":{"type":"string","description":"Type of the object","enum":["deal"],"example":"deal","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.0.object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/deals/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.0.url","typeLabel":"string"},"createdDate":{"oneOf":[{"type":"string","format":"date-time","description":"Created date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.0.createdDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Created date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.0.createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.createdDate","typeLabel":"string\u003cdate-time> | null"},"closeDate":{"oneOf":[{"type":"string","format":"date-time","description":"Close date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.0.closeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Close date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.0.closeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.closeDate","typeLabel":"string\u003cdate-time> | null"},"name":{"oneOf":[{"type":"string","description":"Name of the deal","example":"Deal 1","uniqueKey":"data.workspace.deal.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the deal","example":"Deal 1","uniqueKey":"data.workspace.deal.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.name","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"integer","description":"Amount of the deal","example":"100000","uniqueKey":"data.workspace.deal.oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount of the deal","example":"100000","uniqueKey":"data.workspace.deal.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.amount","typeLabel":"integer | null"},"type":{"oneOf":[{"type":"string","description":"Type of the deal","example":"New Business","uniqueKey":"data.workspace.deal.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Type of the deal","example":"New Business","uniqueKey":"data.workspace.deal.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.type","typeLabel":"string | null"},"stage":{"oneOf":[{"type":"string","description":"Stage of the deal","example":"Proposal Sent","uniqueKey":"data.workspace.deal.oneOf.0.stage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stage of the deal","example":"Proposal Sent","uniqueKey":"data.workspace.deal.oneOf.0.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.0.stage","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.workspace.deal.oneOf.0","typeLabel":"object"},{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.1.id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"salesforceOpportunityId":{"oneOf":[{"type":"string","description":"Salesforce opportunity ID","example":"0015f00000Bg59dAAB","uniqueKey":"data.workspace.deal.oneOf.1.salesforceOpportunityId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salesforce opportunity ID","example":"0015f00000Bg59dAAB","uniqueKey":"data.workspace.deal.oneOf.1.salesforceOpportunityId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.salesforceOpportunityId","typeLabel":"string | null"},"object":{"type":"string","description":"Type of the object","enum":["deal"],"example":"deal","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.1.object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/deals/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.deal.oneOf.1.url","typeLabel":"string"},"createdDate":{"oneOf":[{"type":"string","format":"date-time","description":"Created date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.1.createdDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Created date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.1.createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.createdDate","typeLabel":"string\u003cdate-time> | null"},"closeDate":{"oneOf":[{"type":"string","format":"date-time","description":"Close date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.1.closeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Close date of the deal","example":"2024-01-01T00:00:00Z","uniqueKey":"data.workspace.deal.oneOf.1.closeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.closeDate","typeLabel":"string\u003cdate-time> | null"},"name":{"oneOf":[{"type":"string","description":"Name of the deal","example":"Deal 1","uniqueKey":"data.workspace.deal.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the deal","example":"Deal 1","uniqueKey":"data.workspace.deal.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.name","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"integer","description":"Amount of the deal","example":"100000","uniqueKey":"data.workspace.deal.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount of the deal","example":"100000","uniqueKey":"data.workspace.deal.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.amount","typeLabel":"integer | null"},"type":{"oneOf":[{"type":"string","description":"Type of the deal","example":"New Business","uniqueKey":"data.workspace.deal.oneOf.1.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Type of the deal","example":"New Business","uniqueKey":"data.workspace.deal.oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.type","typeLabel":"string | null"},"stage":{"oneOf":[{"type":"string","description":"Stage of the deal","example":"Proposal Sent","uniqueKey":"data.workspace.deal.oneOf.1.stage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stage of the deal","example":"Proposal Sent","uniqueKey":"data.workspace.deal.oneOf.1.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.deal.oneOf.1.stage","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.workspace.deal.oneOf.1","typeLabel":"object"}],"uniqueKey":"data.workspace.deal","typeLabel":"object"},"customFields":{"type":"array","description":"Custom fields associated with the workspace","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"uniqueKey":"data.workspace.customFields.items.[INDEX].id","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.customFields.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Created at date","example":"2021-01-01T00:00:00.000Z","readOnly":true,"uniqueKey":"data.workspace.customFields.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"object":{"type":"string","description":"Type of the object","enum":["custom-field"],"example":"custom-field","readOnly":true,"uniqueKey":"data.workspace.customFields.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"url":{"type":"string","example":"https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS","description":"URL to the resource","readOnly":true,"uniqueKey":"data.workspace.customFields.items.[INDEX].url","typeLabel":"string"},"variableName":{"type":"string","description":"Variable name of the custom field","example":"account.name","uniqueKey":"data.workspace.customFields.items.[INDEX].variableName","typeLabel":"string"},"type":{"type":"string","description":"Type of the custom field","example":"singleCheckbox","enum":["number","date","singleLineText","multiLineText","richText","singleCheckbox","multiCheckboxes","dropdownSelect","radioSelect"],"uniqueKey":"data.workspace.customFields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"options":{"oneOf":[{"type":"array","description":"For dropdown, radio, and checkbox custom fields, the options","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index of the option","example":1,"uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.0.items.[INDEX].index","typeLabel":"integer"},"label":{"type":"string","description":"Label of the option","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","description":"Value of the option","example":"true","uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"For dropdown, radio, and checkbox custom fields, the options","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index of the option","example":1},"label":{"type":"string","description":"Label of the option","example":"Yes"},"value":{"type":"string","description":"Value of the option","example":"true"}}},"uniqueKey":"data.workspace.customFields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.customFields.items.[INDEX].options","typeLabel":"object[] | null"},"value":{"type":"string","description":"Value of the custom field. For `richText` fields this is returned as HTML.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.workspace.customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.workspace.customFields","typeLabel":"object[]"}},"uniqueKey":"data.workspace","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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","object":"workspace-user","url":"https://api.dock.us/v1/workspace-users/RiHO4e0Ju3DS","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"}}],"workspaceDomains":[{"id":"RiHO4e0Ju3DS","updatedAt":"2021-01-01T00:00:00.000Z","createdAt":"2021-01-01T00:00:00.000Z","object":"workspace-domain","url":"https://api.dock.us/v1/workspace-domains/RiHO4e0Ju3DS","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":"custom-field","url":"https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS","variableName":"account.name","type":"singleCheckbox","options":[{"index":1,"label":"Yes","value":"true"}],"value":"Yes"}]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"f40da9ab-dc08-41c4-ace8-1d4a2b00cbe3":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST"],"description":"A short code indicating the error code returned","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"The request could not be understood or was missing required parameters","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BAD_REQUEST","message":"The request could not be understood or was missing required parameters"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3fce4217-5aa8-4a35-a804-bf126300729a":{"description":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"],"description":"A short code indicating the error code returned","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"Access denied. You are not authorized to access this resource","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Access denied. You are not authorized to access this resource"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9d5527be-5c8c-4fdb-9381-47acd8ab9e68":{"description":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["FORBIDDEN"],"description":"A short code indicating the error code returned","example":"FORBIDDEN","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"Access to this resource is restricted","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"Access to this resource is restricted"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a5ad0d8f-f7be-49b7-8e52-037af274be66":{"description":"The server cannot find the requested resource","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"],"description":"A short code indicating the error code returned","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"The requested resource could not be found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"The requested resource could not be found"}}}},"exampleType":"generated"}},"exampleType":"generated"},"768011fc-1cdc-4a77-aa03-dceb566808b2":{"description":"The user has sent too many requests in a given amount of time (\"rate limiting\")","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["RATE_LIMIT_EXCEEDED"],"description":"A short code indicating the error code returned","example":"RATE_LIMIT_EXCEEDED","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"Rate limit exceeded. Please try again later","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Rate limit exceeded. Please try again later"}}}},"exampleType":"generated"}},"exampleType":"generated"},"061a70ee-359d-4bfe-b7be-6552a5990145":{"description":"The server has encountered a situation it does not know how to handle","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_SERVER_ERROR"],"description":"A short code indicating the error code returned","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong","example":"The server has encountered a situation it does not know how to handle","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"The server has encountered a situation it does not know how to handle"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9f6d0c1a-fd03-4cea-8c0f-f40ae485abf3":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c55415d5-f416-4bba-a736-32deabe53fe8":{"url":"https://api.dock.us/{version}","description":"Production server","variables":{"version":{"default":"v1","enum":["v1"]}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"docklabsinc","siteName":"Dock","title":"Set workspace access with the Dock API - API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T00:52:58.990Z","originalFileLocation":"api-reference/endpoint/workspaces/set-workspace-access.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Set workspace access\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dock\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set workspace access with the Dock API - API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set workspace access\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dock\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docklabsinc.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Set+workspace+access\u0026amp;description=Set+workspace+access\u0026amp;theme=6db68f2e3828f21717cdc0bf\u0026amp;signature=33fde8bf10628f8118e300591b2e719ce7e007469969f882aa8e6f239de385f8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Set workspace access with the Dock API - API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Set workspace access\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docklabsinc.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Set+workspace+access\u0026amp;description=Set+workspace+access\u0026amp;theme=6db68f2e3828f21717cdc0bf\u0026amp;signature=33fde8bf10628f8118e300591b2e719ce7e007469969f882aa8e6f239de385f8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/docklabsinc/3Zgmq5f-wF0-SYL9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dock\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4058FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/workspaces/set-workspace-access.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.dock.us/#organization\",\"name\":\"Dock\",\"url\":\"https://developers.dock.us\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/docklabsinc/pUYB1Rr4_wf6-EkO/logo/light.svg?fit=max\u0026auto=format\u0026n=pUYB1Rr4_wf6-EkO\u0026q=85\u0026s=8d3b9704bcec3086906fe18017582e75\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.dock.us#website\",\"name\":\"Dock\",\"url\":\"https://developers.dock.us\",\"publisher\":{\"@id\":\"https://developers.dock.us/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access#webpage\",\"url\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access\",\"name\":\"Set workspace access\",\"description\":\"Set workspace access\",\"dateModified\":\"2026-11-17T00:52:58.990Z\",\"isPartOf\":{\"@id\":\"https://developers.dock.us#website\"},\"breadcrumb\":{\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspaces\",\"item\":\"https://developers.dock.us/api-reference/endpoint/workspaces/retrieve-a-list-of-workspaces\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspaces\",\"item\":\"https://developers.dock.us/api-reference/endpoint/workspaces/retrieve-a-list-of-workspaces\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set workspace access\",\"item\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access#apireference\",\"headline\":\"Set workspace access\",\"name\":\"Set workspace access\",\"description\":\"Set workspace access\",\"url\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access\",\"mainEntityOfPage\":{\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/set-workspace-access#webpage\"},\"dateModified\":\"2026-11-17T00:52:58.990Z\",\"publisher\":{\"@id\":\"https://developers.dock.us/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.dock.us#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dock\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dock\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/workspaces/set-workspace-access.md","siteName":"Dock","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Welcome to Dock","icon":"rocket","href":"/introduction"},{"title":"Data model","icon":"database","href":"/data-model"},{"title":"Dock MCP","icon":"brain","href":"/dock-mcp/dock-mcp"}]},{"group":"API Reference","pages":[{"title":"Introduction","icon":"book","href":"/api-reference/introduction"},{"title":"API Keys","icon":"key","href":"/api-reference/tokens"},{"title":"Rate limits","icon":"clock","href":"/api-reference/rate-limits"},{"title":"Pagination","icon":"list-ol","href":"/api-reference/pagination"},{"title":"Workspace analytics","icon":"chart-line","href":"/api-reference/workspace-analytics"},{"title":"Uploading files","icon":"file","href":"/api-reference/uploading-files"},{"title":"Errors","icon":"bug","href":"/api-reference/errors"}]},{"group":"Clients","pages":[{"group":"Accounts","pages":[{"title":"Retrieve a list of accounts","openapi":"get /accounts","href":"/api-reference/endpoint/accounts/retrieve-a-list-of-accounts"},{"title":"Create an account","openapi":"post /accounts","href":"/api-reference/endpoint/accounts/create-an-account"},{"title":"Retrieve an account","openapi":"get /accounts/{id}","href":"/api-reference/endpoint/accounts/retrieve-an-account"},{"title":"Update an account","openapi":"patch /accounts/{id}","href":"/api-reference/endpoint/accounts/update-an-account"}]},{"group":"Deals","pages":[{"title":"Retrieve a list of deals","openapi":"get /deals","href":"/api-reference/endpoint/deals/retrieve-a-list-of-deals"},{"title":"Retrieve a deal","openapi":"get /deals/{id}","href":"/api-reference/endpoint/deals/retrieve-a-deal"},{"title":"Update a deal","openapi":"patch /deals/{id}","href":"/api-reference/endpoint/deals/update-a-deal"}]},{"group":"Meetings","pages":[{"title":"Create a meeting","openapi":"post /meetings","href":"/api-reference/endpoint/meetings/create-a-meeting"},{"title":"Retrieve a meeting","openapi":"get /meetings/{id}","href":"/api-reference/endpoint/meetings/retrieve-a-meeting"}]}]},{"group":"Workspaces","pages":[{"group":"Workspaces","pages":[{"title":"Retrieve a list of workspaces","openapi":"get /workspaces","href":"/api-reference/endpoint/workspaces/retrieve-a-list-of-workspaces"},{"title":"Create a workspace","openapi":"post /workspaces","href":"/api-reference/endpoint/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","openapi":"get /workspaces/{id}","href":"/api-reference/endpoint/workspaces/retrieve-a-workspace"},{"title":"Update a workspace","openapi":"patch /workspaces/{id}","href":"/api-reference/endpoint/workspaces/update-a-workspace"},{"title":"Archive a workspace","openapi":"post /workspaces/{id}/archive","description":"Archive a workspace","href":"/api-reference/endpoint/workspaces/archive-a-workspace"},{"title":"Set workspace access","openapi":"post /workspaces/{id}/access","href":"/api-reference/endpoint/workspaces/set-workspace-access"},{"title":"Connect a workspace","openapi":"post /workspaces/{id}/connected-workspaces","description":"Connect a workspace to another workspace, so they share one link, one sidebar and one set of access settings, the same as **Add workspace** in Dock. `{id}` is any workspace in the group to connect to; a workspace that isn't connected to anything yet becomes the group's homepage.\n\nProvide exactly one of:\n\n- `workspaceId` to connect an existing workspace. It must belong to the same account and must not already be connected to other workspaces (disconnect it in Dock first). It takes over the group's access settings, and if it is not published yet it is published with the homepage's users and domains, replacing its own. Connecting a workspace that is already in the group returns `200` and changes nothing.\n- `templateId` to create a new workspace from a template inside the group. It belongs to the group's account and is published with the group's access settings. Unless `workspaceUsers` or `workspaceDomains` are provided, everyone with access to a workspace in the group gets the same access to the new one. Templates that require a deal need `hubspotDealId` or `salesforceOpportunityId`. This costs 10 credits from your company's shared credit balance, and companies on the free plan are limited to 10 workspaces total (active and archived combined).\n\nThe company must be verified to publish workspaces; otherwise this endpoint returns 403 FORBIDDEN.","href":"/api-reference/endpoint/workspaces/connect-a-workspace"},{"title":"Get an authenticated embed url","openapi":"post /workspaces/{id}/authenticated-embed-url","href":"/api-reference/endpoint/workspaces/get-an-authenticated-embed-url"}]},{"group":"Workspace analytics","pages":[{"title":"Retrieve workspace analytics","openapi":"get /workspaces/analytics","href":"/api-reference/endpoint/workspace-analytics/retrieve-workspace-analytics"},{"title":"Retrieve workspace people analytics","openapi":"get /workspaces/analytics/people","href":"/api-reference/endpoint/workspace-analytics/retrieve-workspace-people-analytics"},{"title":"Retrieve workspace page analytics","openapi":"get /workspaces/analytics/pages","href":"/api-reference/endpoint/workspace-analytics/retrieve-workspace-page-analytics"},{"title":"Retrieve workspace asset analytics","openapi":"get /workspaces/analytics/assets","href":"/api-reference/endpoint/workspace-analytics/retrieve-workspace-asset-analytics"},{"title":"Retrieve workspace events","openapi":"get /workspaces/events","href":"/api-reference/endpoint/workspace-analytics/retrieve-workspace-events"}]},{"group":"Templates","pages":[{"title":"Retrieve a list of templates","openapi":"get /templates","href":"/api-reference/endpoint/templates/retrieve-a-list-of-templates"},{"title":"Retrieve a template","openapi":"get /templates/{id}","href":"/api-reference/endpoint/templates/retrieve-a-template"}]},{"group":"Pages","pages":[{"title":"Retrieve a list of workspace pages","openapi":"get /workspace-pages","href":"/api-reference/endpoint/workspace-pages/retrieve-a-list-of-workspace-pages"},{"title":"Retrieve a workspace page","openapi":"get /workspace-pages/{id}","href":"/api-reference/endpoint/workspace-pages/retrieve-a-workspace-page"},{"title":"Update a workspace page","openapi":"patch /workspace-pages/{id}","href":"/api-reference/endpoint/workspace-pages/update-a-workspace-page"}]},{"group":"Sections","pages":[{"title":"Retrieve a list of workspace sections","openapi":"get /workspace-sections","href":"/api-reference/endpoint/workspace-sections/retrieve-a-list-of-workspace-sections"},{"title":"Retrieve a workspace section","openapi":"get /workspace-sections/{id}","href":"/api-reference/endpoint/workspace-sections/retrieve-a-workspace-section"},{"title":"Update a workspace section","openapi":"patch /workspace-sections/{id}","href":"/api-reference/endpoint/workspace-sections/update-a-workspace-section"}]},{"group":"Plans","pages":[{"title":"Retrieve a list of workspace plans","openapi":"get /workspace-plans","href":"/api-reference/endpoint/workspace-plans/retrieve-a-list-of-workspace-plans"},{"title":"Retrieve a workspace plan","openapi":"get /workspace-plans/{id}","href":"/api-reference/endpoint/workspace-plans/retrieve-a-workspace-plan"}]},{"group":"Tasks","pages":[{"title":"Create a workspace plan task","openapi":"post /workspace-plan-tasks","href":"/api-reference/endpoint/workspace-plan-tasks/create-a-workspace-plan-task"},{"title":"Retrieve a list of workspace plan tasks","openapi":"get /workspace-plan-tasks","href":"/api-reference/endpoint/workspace-plan-tasks/retrieve-a-list-of-workspace-plan-tasks"},{"title":"Retrieve a workspace plan task","openapi":"get /workspace-plan-tasks/{id}","href":"/api-reference/endpoint/workspace-plan-tasks/retrieve-a-workspace-plan-task"},{"title":"Update a workspace plan task","openapi":"patch /workspace-plan-tasks/{id}","href":"/api-reference/endpoint/workspace-plan-tasks/update-a-workspace-plan-task"},{"title":"Delete a workspace plan task","openapi":"delete /workspace-plan-tasks/{id}","href":"/api-reference/endpoint/workspace-plan-tasks/delete-a-workspace-plan-task"},{"title":"Retrieve a list of workspace plan task statuses","openapi":"get /workspace-plan-tasks/{id}/statuses","href":"/api-reference/endpoint/workspace-plan-tasks/retrieve-a-list-of-workspace-plan-task-statuses"},{"title":"Create a workspace plan task comment","openapi":"post /workspace-plan-tasks/{id}/comments","href":"/api-reference/endpoint/workspace-plan-tasks/create-a-workspace-plan-task-comment"},{"title":"Retrieve a list of workspace plan task comments","openapi":"get /workspace-plan-tasks/{id}/comments","href":"/api-reference/endpoint/workspace-plan-tasks/retrieve-a-list-of-workspace-plan-task-comments"}]},{"group":"Iframe embeds","pages":[{"title":"Retrieve a list of workspace iframe embeds","openapi":"get /workspace-iframe-embeds","href":"/api-reference/endpoint/workspace-iframe-embeds/retrieve-a-list-of-workspace-iframe-embeds"},{"title":"Retrieve a workspace iframe embed","openapi":"get /workspace-iframe-embeds/{id}","href":"/api-reference/endpoint/workspace-iframe-embeds/retrieve-a-workspace-iframe-embed"},{"title":"Update a workspace iframe embed","openapi":"patch /workspace-iframe-embeds/{id}","href":"/api-reference/endpoint/workspace-iframe-embeds/update-a-workspace-iframe-embed"}]},{"group":"Files","pages":[{"title":"Create a file","openapi":"post /files","href":"/api-reference/endpoint/files/create-a-file"},{"title":"Retrieve a file","openapi":"get /files/{id}","href":"/api-reference/endpoint/files/retrieve-a-file"}]},{"group":"Forms","pages":[{"title":"Retrieve a list of forms","openapi":"get /forms","href":"/api-reference/endpoint/forms/retrieve-a-list-of-forms"},{"title":"Retrieve a form","openapi":"get /forms/{id}","href":"/api-reference/endpoint/forms/retrieve-a-form"},{"title":"Retrieve form responses","openapi":"get /forms/{id}/responses","href":"/api-reference/endpoint/forms/retrieve-form-responses"}]},{"group":"Users","pages":[{"title":"Retrieve a list of workspace users","openapi":"get /workspace-users","href":"/api-reference/endpoint/workspace-users/retrieve-a-list-of-workspace-users"},{"title":"Create a workspace user","openapi":"POST /workspace-users","href":"/api-reference/endpoint/workspace-users/create-a-workspace-user"},{"title":"Retrieve a workspace user","openapi":"get /workspace-users/{id}","href":"/api-reference/endpoint/workspace-users/retrieve-a-workspace-user"},{"title":"Update a workspace user","openapi":"PATCH /workspace-users/{id}","href":"/api-reference/endpoint/workspace-users/update-a-workspace-user"},{"title":"Delete a workspace user","openapi":"delete /workspace-users/{id}","href":"/api-reference/endpoint/workspace-users/delete-a-workspace-user"}]},{"group":"Domains","pages":[{"title":"Retrieve a list of workspace domains","openapi":"get /workspace-domains","href":"/api-reference/endpoint/workspace-domains/retrieve-a-list-of-workspace-domains"},{"title":"Create a workspace domain","openapi":"POST /workspace-domains","href":"/api-reference/endpoint/workspace-domains/create-a-workspace-domain"},{"title":"Retrieve a workspace domain","openapi":"get /workspace-domains/{id}","href":"/api-reference/endpoint/workspace-domains/retrieve-a-workspace-domain"},{"title":"Update a workspace domain","openapi":"PATCH /workspace-domains/{id}","href":"/api-reference/endpoint/workspace-domains/update-a-workspace-domain"},{"title":"Delete a workspace domain","openapi":"delete /workspace-domains/{id}","href":"/api-reference/endpoint/workspace-domains/delete-a-workspace-domain"}]}]},{"group":"Library","pages":[{"group":"Assets","pages":[{"title":"Retrieve a list of assets","openapi":"get /assets","href":"/api-reference/endpoint/assets/retrieve-a-list-of-assets"},{"title":"Retrieve an asset","openapi":"get /assets/{id}","href":"/api-reference/endpoint/assets/retrieve-an-asset"},{"title":"Create an asset","openapi":"post /assets","href":"/api-reference/endpoint/assets/create-an-asset"},{"title":"Update an asset","openapi":"patch /assets/{id}","href":"/api-reference/endpoint/assets/update-an-asset"},{"title":"Delete an asset","openapi":"delete /assets/{id}","href":"/api-reference/endpoint/assets/delete-an-asset"}]},{"group":"Asset share links","pages":[{"title":"Retrieve asset share links","openapi":"get /asset-share-link","href":"/api-reference/endpoint/asset-share-link/retrieve-asset-share-links"},{"title":"Retrieve an asset share link","openapi":"get /asset-share-link/{id}","href":"/api-reference/endpoint/asset-share-link/retrieve-an-asset-share-link"}]},{"group":"Tags","pages":[{"title":"Retrieve a list of tags","openapi":"get /tags","href":"/api-reference/endpoint/tags/retrieve-a-list-of-tags"},{"title":"Create a tag","openapi":"post /tags","href":"/api-reference/endpoint/tags/create-a-tag"},{"title":"Retrieve a tag","openapi":"get /tags/{id}","href":"/api-reference/endpoint/tags/retrieve-a-tag"},{"title":"Update a tag","openapi":"patch /tags/{id}","href":"/api-reference/endpoint/tags/update-a-tag"},{"title":"Delete a tag","openapi":"delete /tags/{id}","href":"/api-reference/endpoint/tags/delete-a-tag"}]}]},{"group":"Learning","pages":[{"group":"Courses","pages":[{"title":"Retrieve a list of courses","openapi":"get /courses","href":"/api-reference/endpoint/courses/retrieve-a-list-of-courses"},{"title":"Retrieve a course","openapi":"get /courses/{id}","href":"/api-reference/endpoint/courses/retrieve-a-course"}]},{"group":"Pathways","pages":[{"title":"Retrieve a list of pathways","openapi":"get /pathways","href":"/api-reference/endpoint/pathways/retrieve-a-list-of-pathways"},{"title":"Retrieve a pathway","openapi":"get /pathways/{id}","href":"/api-reference/endpoint/pathways/retrieve-a-pathway"}]},{"group":"Assignments","pages":[{"title":"Assign learning","openapi":"post /learning-assignments","href":"/api-reference/endpoint/learning-assignments/create-learning-assignments"}]},{"group":"Playbooks","pages":[{"title":"Retrieve a list of playbooks","openapi":"get /playbooks","href":"/api-reference/endpoint/playbooks/retrieve-a-list-of-playbooks"},{"title":"Retrieve a playbook","openapi":"get /playbooks/{id}","href":"/api-reference/endpoint/playbooks/retrieve-a-playbook"}]}]},{"group":"General","pages":[{"group":"Custom fields","pages":[{"title":"Retrieve a list of custom fields","openapi":"get /custom-fields","href":"/api-reference/endpoint/custom-fields/retrieve-a-list-of-custom-fields"},{"title":"Retrieve a custom field","openapi":"get /custom-fields/{id}","href":"/api-reference/endpoint/custom-fields/retrieve-a-custom-field"}]},{"group":"Users","pages":[{"title":"Retrieve a list of users","openapi":"get /users","href":"/api-reference/endpoint/users/retrieve-a-list-of-users"},{"title":"Retrieve a user","openapi":"get /users/{id}","href":"/api-reference/endpoint/users/retrieve-a-user"}]},{"group":"Status check","pages":[{"title":"Ping the API","openapi":"get /ping","href":"/api-reference/endpoint/status-check/ping"}]}]},{"group":"Guides","pages":[{"title":"Embedding workspace","icon":"page","href":"/embedding-workspace"},{"title":"Programmatic iFrame Updates","icon":"frame","href":"/iframe-updates"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]}]},"basePath":"","title":"Set workspace access with the Dock API - API Reference","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}