{
"error": {
"code": "BAD_REQUEST",
"reason": "NOT_FOUND",
"message": "The request could not be understood or was missing required parameters",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>",
"details": [
{
"field": "body.shareSetting",
"message": "'shareSetting' is required in body"
}
]
}
}
{
"error": {
"code": "INVALID_TOKEN",
"reason": "NOT_FOUND",
"message": "Access denied. You are not authorized to access this resource",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "FORBIDDEN",
"reason": "NOT_FOUND",
"message": "Access to this resource is restricted",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "NOT_FOUND",
"reason": "NOT_FOUND",
"message": "The requested resource could not be found",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"reason": "NOT_FOUND",
"message": "The server has encountered a situation it does not know how to handle",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
Workspaces
Update a workspace
Changes a workspace’s custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.
{
"error": {
"code": "BAD_REQUEST",
"reason": "NOT_FOUND",
"message": "The request could not be understood or was missing required parameters",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>",
"details": [
{
"field": "body.shareSetting",
"message": "'shareSetting' is required in body"
}
]
}
}
{
"error": {
"code": "INVALID_TOKEN",
"reason": "NOT_FOUND",
"message": "Access denied. You are not authorized to access this resource",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "FORBIDDEN",
"reason": "NOT_FOUND",
"message": "Access to this resource is restricted",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "NOT_FOUND",
"reason": "NOT_FOUND",
"message": "The requested resource could not be found",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"reason": "NOT_FOUND",
"message": "The server has encountered a situation it does not know how to handle",
"retryable": true,
"requestId": "6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f",
"docUrl": "<string>"
}
}
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Scopes
workspaces:write
Path Parameters
id
string
required
The workspace id
Maximum string length: 64
Pattern: ^[A-Za-z0-9_-]{1,64}$
Example:
"RiHO4e0Ju3DS"
Query Parameters
properties
enum<string>[]
Select the workspace properties that should be returned
Available options:
id,
object,
url,
createdAt,
updatedAt,
name,
workspaceUrl,
templateId,
startDate,
targetEndDate,
actualEndDate,
projectAge,
taskProgress,
lastContactView,
totalViews,
totalActions,
totalTimeSpent,
contactsCount,
workspaceDomains.id,
workspaceDomains.object,
workspaceDomains.url,
workspaceDomains.createdAt,
workspaceDomains.updatedAt,
workspaceDomains.domain,
workspaceDomains.role,
workspaceUsers.id,
workspaceUsers.object,
workspaceUsers.url,
workspaceUsers.createdAt,
workspaceUsers.updatedAt,
workspaceUsers.role,
workspaceUsers.user.id,
workspaceUsers.user.object,
workspaceUsers.user.url,
workspaceUsers.user.createdAt,
workspaceUsers.user.updatedAt,
workspaceUsers.user.firstName,
workspaceUsers.user.lastName,
workspaceUsers.user.avatar,
workspaceUsers.user.email,
workspaceUsers.user.name,
account.id,
account.object,
account.url,
account.createdAt,
account.updatedAt,
account.name,
account.website,
account.ownerId,
account.logo,
account.salesforceAccountId,
account.hubspotCompanyId,
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.hubspotDealId,
deal.salesforceOpportunityId,
deal.name,
deal.amount,
deal.closeDate,
deal.createdDate,
deal.stage,
deal.type,
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.name,
customFields.variableName,
customFields.objectType,
customFields.type,
customFields.options.index,
customFields.options.label,
customFields.options.value,
customFields.value
Body
application/json
customFields
object[]
Custom fields to update. Only the fields in this list change. For a multiple-checkbox field, the value replaces the field's selected options.
The start date of the workspace in YYYY-MM-DD format, or null to remove the date
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:
"2025-06-15"
targetEndDate
string<date> | null
The target end date of the workspace in YYYY-MM-DD format, or null to remove the date
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:
"2025-08-31"
actualEndDate
string<date> | null
The actual end date of the workspace in YYYY-MM-DD format, or null to remove the date
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:
"2025-09-30"
Response
Success: update a workspace
data
object
required
Show child attributes
{"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":"6b00d423e1d4cf3959dd43d9","clientVersion":"0.0.4270","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":"site-roles","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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/endpoint/workspaces/update-a-workspace","slug":"/api-reference/endpoint/workspaces/update-a-workspace","pageMetadata":{"title":"Update a workspace","openapi":"patch /workspaces/{id}","og:title":"Update a workspace with the Dock API - API Reference","description":"Changes a workspace's custom field values and dates, and returns it with the fields `properties` asks for. Only the custom fields sent change; a date sent as `null` is removed. A playbook id, or one from another company, returns 404. Needs `workspaces:write`.","href":"/api-reference/endpoint/workspaces/update-a-workspace"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Changes a workspace’s custom field values and dates, and returns it with the fields \", _jsx(_components.code, {\n children: \"properties\"\n }), \" asks for. Only the custom fields sent change; a date sent as \", _jsx(_components.code, {\n children: \"null\"\n }), \" is removed. A playbook id, or one from another company, returns 404. Needs \", _jsx(_components.code, {\n children: \"workspaces:write\"\n }), \".\"]\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":"Update a workspace","openapi":"patch /workspaces/{id}","og:title":"Update a workspace with the Dock API - API Reference","description":"Changes a workspace's custom field values and dates, and returns it with the fields `properties` asks for. Only the custom fields sent change; a date sent as `null` is removed. A playbook id, or one from another company, returns 404. Needs `workspaces:write`.","href":"/api-reference/endpoint/workspaces/update-a-workspace"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[126,522,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"workspaces.update","summary":"Update a workspace","description":"Changes a workspace's custom field values and dates, and returns it with the fields `properties` asks for. Only the custom fields sent change; a date sent as `null` is removed. A playbook id, or one from another company, returns 404. Needs `workspaces:write`.","tags":["Workspaces"],"security":["b64c994c-d982-4837-9a25-6dbebf46b56f"],"x-dock-kind":"resource","x-dock-risk":"write","x-dock-rate-limit":["general"],"parameters":["6fc25a97-a419-437a-8a8f-97551c2e587b","79ef0734-268c-4562-ac7d-1ccde6c61df5"],"requestBody":"0085023b-35e0-46ea-9a8c-1eea45bb2672","responses":{"200":"33b96654-12a7-44ed-b1a0-a4b6c150e0be","400":"63c2f506-5e4f-4030-b6a5-90abaccd7e6b","401":"fefda02f-559c-404e-840c-df1147817c15","403":"b8ec1266-003f-4089-8f65-975a9c74ee74","404":"e03d5939-1d26-4b11-9d67-06849f821b1f","429":"65d73bf4-60f7-46f8-9d00-4e8425314f9c","500":"82778e7f-0e3d-4ebd-8f3d-53c0fa58eb91"},"method":"patch","type":"path","servers":["d3594d6a-4877-469b-9760-bd07b56da81d"],"path":"/workspaces/{id}","baseUrlOptions":["https://api.dock.us/{version}"],"title":"Update a workspace","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6fc25a97-a419-437a-8a8f-97551c2e587b":{"name":"id","in":"path","description":"The workspace id","required":true,"schema":{"type":"string","maxLength":64,"pattern":"^[A-Za-z0-9_-]{1,64}$","example":"RiHO4e0Ju3DS","isRequired":true,"description":"The workspace id","uniqueKey":"","typeLabel":"string"}},"79ef0734-268c-4562-ac7d-1ccde6c61df5":{"name":"properties","in":"query","description":"Select the workspace properties that should be returned","required":false,"schema":{"type":"array","items":{"type":"string","enum":["id","object","url","createdAt","updatedAt","name","workspaceUrl","templateId","startDate","targetEndDate","actualEndDate","projectAge","taskProgress","lastContactView","totalViews","totalActions","totalTimeSpent","contactsCount","workspaceDomains.id","workspaceDomains.object","workspaceDomains.url","workspaceDomains.createdAt","workspaceDomains.updatedAt","workspaceDomains.domain","workspaceDomains.role","workspaceUsers.id","workspaceUsers.object","workspaceUsers.url","workspaceUsers.createdAt","workspaceUsers.updatedAt","workspaceUsers.role","workspaceUsers.user.id","workspaceUsers.user.object","workspaceUsers.user.url","workspaceUsers.user.createdAt","workspaceUsers.user.updatedAt","workspaceUsers.user.firstName","workspaceUsers.user.lastName","workspaceUsers.user.avatar","workspaceUsers.user.email","workspaceUsers.user.name","account.id","account.object","account.url","account.createdAt","account.updatedAt","account.name","account.website","account.ownerId","account.logo","account.salesforceAccountId","account.hubspotCompanyId","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.hubspotDealId","deal.salesforceOpportunityId","deal.name","deal.amount","deal.closeDate","deal.createdDate","deal.stage","deal.type","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.name","customFields.variableName","customFields.objectType","customFields.type","customFields.options.index","customFields.options.label","customFields.options.value","customFields.value"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Select the workspace properties that should be returned","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customFields":{"default":[],"description":"Custom fields to update. Only the fields in this list change. For a multiple-checkbox field, the value replaces the field's selected options.","example":[{"id":"RiHO4e0Ju3DS","value":"Enterprise"},{"id":"PkT2mVq81xLc","value":["Option A","Option B"]}],"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":64,"pattern":"^[A-Za-z0-9_-]{1,64}$","isRequired":true,"uniqueKey":"customFields.items.[INDEX].id","typeLabel":"string"},"value":{"oneOf":[{"type":"string","maxLength":100000,"uniqueKey":"customFields.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","maxLength":20000,"uniqueKey":"customFields.items.[INDEX].value.oneOf.1.items.[INDEX]","typeLabel":"string"},"maxItems":100,"minItems":0,"uniqueKey":"customFields.items.[INDEX].value.oneOf.1","typeLabel":"string[]"},{"type":"number","uniqueKey":"customFields.items.[INDEX].value.oneOf.2","typeLabel":"number"},{"type":"null","uniqueKey":"customFields.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"boolean","uniqueKey":"customFields.items.[INDEX].value.oneOf.4","typeLabel":"boolean"}],"uniqueKey":"customFields.items.[INDEX].value","typeLabel":"string | string[] | number | null | boolean"}},"required":["id"],"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customFields","typeLabel":"object[]"},"startDate":{"oneOf":[{"type":"string","description":"The start date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2025-06-15","uniqueKey":"startDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The start date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","example":"2025-06-15","uniqueKey":"startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"startDate","typeLabel":"string\u003cdate> | null"},"targetEndDate":{"oneOf":[{"type":"string","description":"The target end date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2025-08-31","uniqueKey":"targetEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The target end date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","example":"2025-08-31","uniqueKey":"targetEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"targetEndDate","typeLabel":"string\u003cdate> | null"},"actualEndDate":{"oneOf":[{"type":"string","description":"The actual end date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2025-09-30","uniqueKey":"actualEndDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","description":"The actual end date of the workspace in `YYYY-MM-DD` format, or `null` to remove the date","example":"2025-09-30","uniqueKey":"actualEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"actualEndDate","typeLabel":"string\u003cdate> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customFields":[{"id":"RiHO4e0Ju3DS","value":"Enterprise"},{"id":"PkT2mVq81xLc","value":["Option A","Option B"]}],"startDate":"2025-06-15","targetEndDate":"2025-08-31","actualEndDate":"2025-09-30"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"33b96654-12a7-44ed-b1a0-a4b6c150e0be":{"description":"Success: update a workspace","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier","isRequired":true,"uniqueKey":"data.workspace.id","typeLabel":"string"},"object":{"type":"string","const":"workspace","description":"Type of the object","isRequired":true,"uniqueKey":"data.workspace.object","typeLabel":"string"},"url":{"type":"string","description":"The URL of the object in the API","isRequired":true,"uniqueKey":"data.workspace.url","typeLabel":"string"},"createdAt":{"description":"When the workspace was created","type":"string","format":"date-time","uniqueKey":"data.workspace.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"description":"When the workspace last changed","type":"string","format":"date-time","uniqueKey":"data.workspace.updatedAt","typeLabel":"string\u003cdate-time>"},"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 template the workspace was made from","example":"RiHO4e0Ju3DS","uniqueKey":"data.workspace.templateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the template the workspace was made from","example":"RiHO4e0Ju3DS","uniqueKey":"data.workspace.templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.templateId","typeLabel":"string | null"},"startDate":{"type":"string","description":"Start date of the workspace","format":"date","example":"2024-01-01","uniqueKey":"data.workspace.startDate","typeLabel":"string\u003cdate>"},"targetEndDate":{"type":"string","description":"Target end date of the workspace","format":"date","example":"2024-01-01","uniqueKey":"data.workspace.targetEndDate","typeLabel":"string\u003cdate>"},"actualEndDate":{"type":"string","description":"Actual end date of the workspace","format":"date","example":"2024-01-01","uniqueKey":"data.workspace.actualEndDate","typeLabel":"string\u003cdate>"},"projectAge":{"type":"number","description":"Days from the start date to the end date, or to today","example":100,"uniqueKey":"data.workspace.projectAge","typeLabel":"number"},"taskProgress":{"type":"string","description":"Percentage of tasks completed, to two decimals","example":"50.00","uniqueKey":"data.workspace.taskProgress","typeLabel":"string"},"lastContactView":{"oneOf":[{"type":"string","description":"When a contact last viewed the workspace","format":"date-time","uniqueKey":"data.workspace.lastContactView.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When a contact last viewed the workspace","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 in the workspace","example":100,"uniqueKey":"data.workspace.totalActions","typeLabel":"number"},"totalTimeSpent":{"oneOf":[{"type":"number","description":"Total time contacts spent in the workspace","example":100,"uniqueKey":"data.workspace.totalTimeSpent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total time contacts spent in the workspace","example":100,"uniqueKey":"data.workspace.totalTimeSpent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.workspace.totalTimeSpent","typeLabel":"number | null"},"contactsCount":{"type":"number","description":"Number of contacts of the workspace","example":100,"uniqueKey":"data.workspace.contactsCount","typeLabel":"number"},"workspaceDomains":{"type":"array","description":"Domains of the workspace","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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","maxLength":253,"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX].domain","typeLabel":"string\u003chostname>"}},"uniqueKey":"data.workspace.workspaceDomains.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.workspace.workspaceDomains","typeLabel":"object[]"},"workspaceUsers":{"type":"array","description":"Users of the workspace","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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,"maxLength":64,"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[]"},"account":{"type":"object","description":"The account of the workspace","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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"},"deal":{"oneOf":[{"type":"object","description":"The deal of the workspace","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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","description":"The deal of the workspace","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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"},{"type":"null","description":"The deal of the workspace","uniqueKey":"data.workspace.deal.oneOf.2","typeLabel":"null"}],"uniqueKey":"data.workspace.deal","typeLabel":"object · object · null"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the object","example":"RiHO4e0Ju3DS","readOnly":true,"maxLength":64,"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":{"oneOf":[{"type":"string","description":"Value of the custom field, or `null` when it has none: text for text, date (`YYYY-MM-DD`) and dropdown fields (HTML for `richText`), a number for number fields, a boolean for a single checkbox, and a list of option labels for multiple checkboxes.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value of the custom field, or `null` when it has none: text for text, date (`YYYY-MM-DD`) and dropdown fields (HTML for `richText`), a number for number fields, a boolean for a single checkbox, and a list of option labels for multiple checkboxes.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value of the custom field, or `null` when it has none: text for text, date (`YYYY-MM-DD`) and dropdown fields (HTML for `richText`), a number for number fields, a boolean for a single checkbox, and a list of option labels for multiple checkboxes.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"Value of the custom field, or `null` when it has none: text for text, date (`YYYY-MM-DD`) and dropdown fields (HTML for `richText`), a number for number fields, a boolean for a single checkbox, and a list of option labels for multiple checkboxes.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.3","typeLabel":"string[]"},{"type":"null","description":"Value of the custom field, or `null` when it has none: text for text, date (`YYYY-MM-DD`) and dropdown fields (HTML for `richText`), a number for number fields, a boolean for a single checkbox, and a list of option labels for multiple checkboxes.","example":"Yes","uniqueKey":"data.workspace.customFields.items.[INDEX].value.oneOf.4","typeLabel":"null"}],"uniqueKey":"data.workspace.customFields.items.[INDEX].value","typeLabel":"string | number | boolean | string[] | null"}},"uniqueKey":"data.workspace.customFields.items.[INDEX]","typeLabel":"object"},"description":"Custom fields of the workspace","uniqueKey":"data.workspace.customFields","typeLabel":"object[]"}},"required":["id","object","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.workspace","typeLabel":"object"}},"required":["workspace"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"workspace":{"id":"\u003cstring>","object":"workspace","url":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","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.00","lastContactView":"2023-11-07T05:31:56Z","totalViews":100,"totalActions":100,"totalTimeSpent":100,"contactsCount":100,"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"}],"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"}}],"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"},"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"},"63c2f506-5e4f-4030-b6a5-90abaccd7e6b":{"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>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"},"details":{"type":"array","description":"With `INVALID_INPUT`: one entry per invalid field.","items":{"type":"object","properties":{"field":{"type":"string","description":"The field's path, starting with `body`, `query` or `params`.","example":"body.shareSetting","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"What is wrong with the field.","example":"'shareSetting' is required in body","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","requestId","reason","retryable","docUrl"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"BAD_REQUEST","reason":"NOT_FOUND","message":"The request could not be understood or was missing required parameters","retryable":true,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>","details":[{"field":"body.shareSetting","message":"'shareSetting' is required in body"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"fefda02f-559c-404e-840c-df1147817c15":{"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":["NO_TOKEN","INVALID_TOKEN"],"description":"`NO_TOKEN`: no `Authorization: Bearer` header. `INVALID_TOKEN`: the key or token is not one Dock knows.","example":"INVALID_TOKEN","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"}},"required":["code","message","requestId","reason","retryable","docUrl"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_TOKEN","reason":"NOT_FOUND","message":"Access denied. You are not authorized to access this resource","retryable":true,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b8ec1266-003f-4089-8f65-975a9c74ee74":{"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","API_KEY_PAUSED"],"description":"A short code indicating the error code returned. `API_KEY_PAUSED`: an admin paused the key; resume it in Settings → API.","example":"FORBIDDEN","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"}},"required":["code","message","requestId","reason","retryable","docUrl"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","reason":"NOT_FOUND","message":"Access to this resource is restricted","retryable":true,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e03d5939-1d26-4b11-9d67-06849f821b1f":{"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>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"}},"required":["code","message","requestId","reason","retryable","docUrl"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","reason":"NOT_FOUND","message":"The requested resource could not be found","retryable":true,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"65d73bf4-60f7-46f8-9d00-4e8425314f9c":{"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>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"retryAfter":{"type":"integer","minimum":1,"description":"Seconds to wait before retrying; the same as the `Retry-After` header.","isRequired":true,"uniqueKey":"error.retryAfter","typeLabel":"integer"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"}},"required":["code","message","requestId","reason","retryable","docUrl","retryAfter"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","reason":"NOT_FOUND","message":"Rate limit exceeded. Please try again later","retryable":true,"retryAfter":2,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"82778e7f-0e3d-4ebd-8f3d-53c0fa58eb91":{"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>"},"reason":{"type":"string","description":"What exactly went wrong; branch on this. Each reason is listed on the [errors page](/api-reference/errors).","example":"NOT_FOUND","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"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"},"retryable":{"type":"boolean","description":"Whether sending the same request again, unchanged, can succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"The request's `X-Request-Id`. Quote it when contacting support.","example":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"docUrl":{"type":"string","format":"uri","description":"The reason's section on the errors page.","isRequired":true,"uniqueKey":"error.docUrl","typeLabel":"string\u003curi>"}},"required":["code","message","requestId","reason","retryable","docUrl"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","reason":"NOT_FOUND","message":"The server has encountered a situation it does not know how to handle","retryable":true,"requestId":"6f1c2a9e-3b4d-4c5e-8f70-1a2b3c4d5e6f","docUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b64c994c-d982-4837-9a25-6dbebf46b56f":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":["workspaces:write"],"schemeName":"bearerAuth"}}},"servers":{"d3594d6a-4877-469b-9760-bd07b56da81d":{"url":"https://api.dock.us/{version}","description":"Production server","variables":{"version":{"default":"v1","enum":["v1"]}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":["workspaces:write"],"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":"Update a workspace with the Dock API - API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T23:13:47.250Z","originalFileLocation":"api-reference/endpoint/workspaces/update-a-workspace.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=\"Changes a workspace\u0026#x27;s custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.\">\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=\"Update a workspace with the Dock API - API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes a workspace\u0026#x27;s custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.\">\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/update-a-workspace\">\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=Update+a+workspace\u0026amp;description=Changes+a+workspace%27s+custom+field+values+and+dates%2C+and+returns+it+with+the+fields+%60properties%60+asks+for.+Only+the+custom+fields+sent+change%3B+a+date+sent+as+%60n\u0026amp;theme=6db68f2e3828f21717cdc0bf\u0026amp;signature=26b2b5dd1facb49068212c54f769e62b61c87b8780f259d93b89d1848799f425\">\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=\"Update a workspace with the Dock API - API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes a workspace\u0026#x27;s custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docklabsinc.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Update+a+workspace\u0026amp;description=Changes+a+workspace%27s+custom+field+values+and+dates%2C+and+returns+it+with+the+fields+%60properties%60+asks+for.+Only+the+custom+fields+sent+change%3B+a+date+sent+as+%60n\u0026amp;theme=6db68f2e3828f21717cdc0bf\u0026amp;signature=26b2b5dd1facb49068212c54f769e62b61c87b8780f259d93b89d1848799f425\">\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/update-a-workspace\">\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/update-a-workspace.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/update-a-workspace#webpage\",\"url\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace\",\"name\":\"Update a workspace\",\"description\":\"Changes a workspace's custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.\",\"dateModified\":\"2026-11-20T23:13:47.250Z\",\"isPartOf\":{\"@id\":\"https://developers.dock.us#website\"},\"breadcrumb\":{\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace#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\":\"Update a workspace\",\"item\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace#apireference\",\"headline\":\"Update a workspace\",\"name\":\"Update a workspace\",\"description\":\"Changes a workspace's custom field values and dates, and returns it with the fields properties asks for. Only the custom fields sent change; a date sent as null is removed. A playbook id, or one from another company, returns 404. Needs workspaces:write.\",\"url\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://developers.dock.us/api-reference/endpoint/workspaces/update-a-workspace#webpage\"},\"dateModified\":\"2026-11-20T23:13:47.250Z\",\"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/update-a-workspace.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}","description":"Returns one workspace by its id with the fields `properties` asks for (`id`, `object` and `url` when it asks for none). A playbook id, or one from another company, returns 404; use Retrieve a playbook for playbooks. Needs `workspaces:read`.","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":"Archives a workspace, as Archive does in Dock, and returns its id. Archived workspaces still count toward the free plan limit. A playbook id, or one from another company, returns 404. Needs `workspaces:write`.","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","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":"Update a workspace with the Dock API - API Reference","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}