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