{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/tasks/{taskId}.json","auth":"required","examples":{"codes":[{"name":"","language":"javascript","code":"var data = {\n     task: {\n           percentComplete: 50,\n       \t\t customColumns:\n             [\n               { name: \"MyCurrencyCol\", type: \"currency\", data: \"95.99\", extendedColumnId=567},\n               { name: \"MyNumberCol\", type: \"number\", data: \"1234\", extendedColumnId=568},\n               { name: \"MyDateCol\", type: \"currency\", data: \"27-01-2018\", extendedColumnId=569},\n               { name: \"MyStringCol\", type: \"string\", data: \"Spiffy Sprockets\", extendedColumnId=570},\n               { name: \"MyBoolCol\", type: \"bool\", data: \"true\", extendedColumnId=571}\n             ]\n           }\n     }\n\n\n$.ajax({\n     type: \"PUT\", \n  \t url: \"/api/v1/tasks/28178217.json\", \n  \t contentType: 'application/json', \n  \t dataType: \"json\", \n     success: worked,\n  \t data: JSON.stringify(data),\n     headers: { apiKey: apiKey }\n});"}]},"method":"put","params":[{"name":"percentComplete","type":"int","default":"null","desc":"Your task percent completed","required":false,"in":"body","ref":"","_id":"5565161403b6710d00916940"},{"name":"notes","type":"string","default":"null","desc":"Your tasks notes.","required":false,"in":"body","ref":"","_id":"5565161403b6710d0091693f"},{"name":"customColumns","type":"array_object","default":"","desc":"Task-level custom columns and their value. (Note: the column must have been previously created for the project before you can post it here)","required":false,"in":"body","ref":"","_id":"58d9a9b6feb7602700ce498e"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"Okay\",\n    \"task\": {\n        \"children\": [\n            28178219 // note this is not task object but the children task id\n        ],\n        \"actual\": {\n            \"cost\": 0.0,\n            \"duration\": null,\n            \"effort\": 480,\n            \"finish\": null,\n            \"resourceCost\": 0.0,\n            \"start\": null\n        },\n        \"assignments\": null,\n        \"baseline\": null,\n        \"isMilestone\": false,\n        \"isSummary\": true,\n        \"notes\": null,\n        \"percentComplete\": null,\n        \"planned\": {\n            \"cost\": 0.0,\n            \"duration\": 3840,\n            \"effort\": 1200,\n            \"finish\": null,\n            \"resourceCost\": 0.0,\n            \"start\": \"2015-05-07T00:00:00\"\n        },\n        \"predeccesors\": null,\n        \"priority\": 600,\n        \"successors\": null,\n        \"wbs\": \"1\",\n        \"id\": 28178218,\n        \"name\": \"a\",\n        \"customColumns\":\n          [\n            { name: \"MyCurrencyCol\", type: \"currency\", data: \"95.99\", extendedColumnId=567},\n            { name: \"MyNumberCol\", type: \"number\", data: \"1234\", extendedColumnId=568},\n            { name: \"MyDateCol\", type: \"currency\", data: \"27-01-2018\", extendedColumnId=569},\n            { name: \"MyStringCol\", type: \"string\", data: \"Spiffy Sprockets\", extendedColumnId=570},\n            { name: \"MyBoolCol\", type: \"bool\", data: \"true\", extendedColumnId=571}\n          ]\n    }\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Update a Task","type":"endpoint","slug":"update-a-task","excerpt":"A Task instance represents a task created within a Project. It may be a high level summary task, or a task within a task. \n\nUse this API to update an existing task.","body":"Use this API to update a task's details.\n\nReturns the fully fleshed out task object that was updated.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"554a8088d665ae0d00383f77","createdAt":"2015-05-06T20:58:48.157Z","user":"55484649b2581a0d00913ff3","githubsync":"","parentDoc":null,"__v":7,"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["554a7f3d6b448d0d00646b97","554a7f5e6b448d0d00646b99","554a7fa0d665ae0d00383f65","554a8077d665ae0d00383f75","554a8088d665ae0d00383f77"],"title":"Tasks","slug":"tasks","order":2,"from_sync":false,"reference":false,"_id":"554a7f3338e3620d0082192e","version":"5548466bd2c8410d006c2146","project":"5548466bd2c8410d006c2143","__v":5,"createdAt":"2015-05-06T20:53:07.204Z"},"editedParams":true,"project":"5548466bd2c8410d006c2143","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"_id":"5548466bd2c8410d006c2146","createdAt":"2015-05-05T04:26:19.796Z","project":"5548466bd2c8410d006c2143","__v":8,"releaseDate":"2015-05-05T04:26:19.796Z"}}

putUpdate a Task

A Task instance represents a task created within a Project. It may be a high level summary task, or a task within a task. Use this API to update an existing task.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

percentComplete:
integernull
Your task percent completed
notes:
stringnull
Your tasks notes.
customColumns:
array of objects
Task-level custom columns and their value. (Note: the column must have been previously created for the project before you can post it here)

Examples


Result Format


Documentation

Use this API to update a task's details. Returns the fully fleshed out task object that was updated.