Skip to main content
PATCH
/
workspace-plan-tasks
/
{id}
cURL
curl --request PATCH \
  --url https://api.dock.us/{version}/workspace-plan-tasks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "completed": false
}
'
{
  "data": {
    "workspacePlanTask": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "object": "workspacePlanTask",
      "url": "https://api.dock.us/v1/workspace-plan-tasks/RiHO4e0Ju3DS",
      "isInternal": false,
      "status": "In Progress",
      "completedAt": "2024-01-01T00:00:00Z",
      "actionLinkUrl": "https://acme.dock.us/onboarding",
      "actionLinkName": "View onboarding plan",
      "actionText": "View onboarding plan",
      "actionType": "link",
      "showActionText": true,
      "startDate": "2024-01-01",
      "title": "Create onboarding plan",
      "dueDate": "2024-01-01",
      "index": 0,
      "templatePlanTaskId": "RiHO4e0Ju3DS"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

Select the workspace plan task properties that should be returned

Available options:
isInternal,
status,
completedAt,
actionLinkUrl,
actionLinkName,
actionText,
actionType,
showActionText,
startDate,
title,
dueDate,
index,
createdAt,
updatedAt,
templatePlanTaskId

Body

application/json
​
completed
boolean

Whether the task is completed

Example:

false

Response

Update a workspace plan task by ID

​
data
object