API Reference

Partially update a single task

Description

Partially updates the properties of a task.

PATCH /tasks/{taskId}

🚧

Required OAuth Scopes:

task:write

Parameters

ParameterInTypeRequiredDescription
taskIdpathstringtrueThe unique identifier of the task
bodybodyJSONPatchDocumenttrueA collection of patch operations to apply to the task.

Body parameter example

[
  {
    "op": "replace",
    "path": "/title",
    "value": "New Title"
  }
]

Code Samples

curl -X PATCH https://api.app.wdesk.com/platform/v1/tasks/{taskId}  \ 
-H 'Content-Type: application/json' \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http PATCH https://api.app.wdesk.com/platform/v1/tasks/{taskId}  \ 
Content-Type:application/json \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=PATCH "https://api.app.wdesk.com/platform/v1/tasks/{taskId}" \
 --output-document -  \ 
 --header 'Content-Type: application/json' \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.app.wdesk.com/platform/v1/tasks/{taskId}', headers = headers)

print(r.json())

Returns

200 - OK

Returns a Task object containing details about the updated Task.

Example Responses


{
  "id": "129g274495354cf18edb6b3ea3d023b2",
  "title": "Review Document",
  "description": "Review document for spelling and grammar",
  "status": "Completed",
  "dueDate": "2019-10-30T00:00:00Z",
  "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF4OENNJEV3NUTBmA?token=NTc0NDU2MTg1MjM0ODUyTM",
  "completed": {
    "dateTime": "2019-10-29T15:03:27Z"
  },
  "modified": {
    "dateTime": "2019-10-29T15:03:27Z"
  },
  "assignee": {
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
    "displayName": "Jane Doe",
    "email": "[email protected]"
  },
  "created": {
    "user": {
      "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
      "displayName": "John Doe",
      "email": "[email protected]"
    },
    "dateTime": "2019-10-28T15:03:27Z"
  },
  "location": {
    "file": "124efa2a142f472ba1ceab34ed18915f",
    "fileSegment": "465ttdh2a142y75ehsft5ab34edf5675"
  }
}