API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Update a workspace section
Update a workspace section by ID
curl --request PATCH \
--url https://api.dock.so:4000/{version}/workspace-sections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"isHidden": false
}'
{
"data": {
"workspaceSection": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspaceSection",
"url": "https://api.dock.us/v1/workspace-sections/RiHO4e0Ju3DS",
"name": "Planning",
"navigationName": "Home",
"index": 0,
"isHidden": false,
"isSynced": false,
"isCollaborative": false,
"isHiddenFromNavigation": false,
"templateSectionId": "RiHO4e0Ju3DS"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier
"RiHO4e0Ju3DS"
Query Parameters
Select the workspace section properties that should be returned
name
, navigationName
, isHidden
, index
, isSynced
, isCollaborative
, isHiddenFromNavigation
, createdAt
, updatedAt
, templateSectionId
Body
Whether the section is hidden
false
Response
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
workspaceSection
"workspaceSection"
URL to the resource
"https://api.dock.us/v1/workspace-sections/RiHO4e0Ju3DS"
Name of the workspace section
"Planning"
Navigation name of the workspace section
"Home"
Index of the workspace section
0
Whether the workspace section is hidden
false
Whether the workspace section is synced
false
Whether the workspace section is collaborative
false
Whether the workspace section is hidden from navigation
false
ID of the associated template section
"RiHO4e0Ju3DS"
curl --request PATCH \
--url https://api.dock.so:4000/{version}/workspace-sections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"isHidden": false
}'
{
"data": {
"workspaceSection": {
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspaceSection",
"url": "https://api.dock.us/v1/workspace-sections/RiHO4e0Ju3DS",
"name": "Planning",
"navigationName": "Home",
"index": 0,
"isHidden": false,
"isSynced": false,
"isCollaborative": false,
"isHiddenFromNavigation": false,
"templateSectionId": "RiHO4e0Ju3DS"
}
}
}