Updates the task with the specified id.

PUT

https://api.awork.com/api/v1/tasks/:taskId

PUT

/api/v1/tasks/:taskId

1 curl -X PUT https://api.awork.com/api/v1/tasks/taskId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Create logo concept"
6 }'

Try it

200Updated

1 {
2   "name": "Create logo concept",
3   "description": "We need to create a new impactful concept for the customer logo",
4   "isPrio": true,
5   "startOn": "2023-03-03T17:00:00Z",
6   "dueOn": "2023-03-18T17:00:00Z",
7   "laneOrder": 1,
8   "plannedDuration": 21600,
9   "id": "123e4567-e89b-12d3-a456-426614174000",
10   "taskNumber": 1,
11   "taskIdentifier": "string",
12   "isExternal": true,
13   "createdVia": "string",
14   "isHiddenForConnectUsers": true,
15   "baseType": "projecttask",
16   "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
17   "taskStatus": {
18     "id": "123e4567-e89b-12d3-a456-426614174000",
19     "name": "Conceptualize",
20     "type": "progress",
21     "order": 2,
22     "icon": "arrow_forward",
23     "projectId": "123e4567-e89b-12d3-a456-426614174000",
24     "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
25     "createdOn": "2022-03-{10}T15:51:58.100Z",
26     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
27     "updatedOn": "2022-03-10T16:15:26.100Z",
28     "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
29   },
30   "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
31   "typeOfWork": {
32     "id": "123e4567-e89b-12d3-a456-426614174000",
33     "name": "Design",
34     "icon": "thumb_up",
35     "isArchived": false
36   },
37   "assignees": [
38     {
39       "id": "123e4567-e89b-12d3-a456-426614174000",
40       "firstName": "Carla",
41       "lastName": "Creative",
42       "hasImage": true,
43       "plannedEffort": 1,
44       "isDistributedPlannedEffort": true,
45       "updatedOn": "2020-02-30T18:52:54.945Z",
46       "isExternal": true,
47       "tags": [
48         {
49           "id": "123e4567-e89b-12d3-a456-426614174000",
50           "name": "Design",
51           "color": "purple"
52         }
53       ],
54       "teams": [
55         {
56           "id": "123e4567-e89b-12d3-a456-426614174000"
57         }
58       ]
59     }
60   ],
61   "projectId": "123e4567-e89b-12d3-a456-426614174000",
62   "project": {
63     "id": "123e4567-e89b-12d3-a456-426614174000",
64     "name": "Design",
65     "projectStatus": {
66       "id": "123e4567-e89b-12d3-a456-426614174000",
67       "name": "Design",
68       "description": "Work in progress",
69       "type": "todo",
70       "isArchived": false
71     },
72     "company": {
73       "id": "123e4567-e89b-12d3-a456-426614174000",
74       "name": "Design",
75       "hasImage": true,
76       "description": "NCNSTN Brand Design Company",
77       "tags": [
78         {
79           "id": "123e4567-e89b-12d3-a456-426614174000",
80           "name": "Design",
81           "color": "purple"
82         }
83       ]
84     },
85     "companyId": "123e4567-e89b-12d3-a456-426614174000",
86     "projectType": {
87       "id": "123e4567-e89b-12d3-a456-426614174000",
88       "name": "Design",
89       "icon": "thumb_up",
90       "isArchived": false
91     },
92     "hasImage": true,
93     "isPrivate": true,
94     "isBillableByDefault": true,
95     "members": [
96       {
97         "id": "123e4567-e89b-12d3-a456-426614174000",
98         "userId": "123e4567-e89b-12d3-a456-426614174000",
99         "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
100         "projectRoleName": "string",
101         "isResponsible": true,
102         "isExternal": true
103       }
104     ],
105     "color": "purple",
106     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
107     "teams": [
108       {
109         "id": "123e4567-e89b-12d3-a456-426614174000"
110       }
111     ],
112     "customFields": [
113       {
114         "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
115         "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
116         "clientIdValue": "123e4567-e89b-12d3-a456-426614174000",
117         "numberValue": 123.45,
118         "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
119         "selectionOption": {
120           "value": "Website Design",
121           "order": 0,
122           "id": "123e4567-e89b-12d3-a456-426614174000",
123           "color": "purple"
124         },
125         "textValue": "S1: Business Critical",
126         "dateValue": "2024-01-15T09:30:00Z",
127         "booleanValue": true
128       }
129     ],
130     "isExternal": true,
131     "tags": [
132       {
133         "id": "123e4567-e89b-12d3-a456-426614174000",
134         "name": "Design",
135         "color": "purple"
136       }
137     ]
138   },
139   "correlationId": "123e4567-e89b-12d3-a456-426614174000",
140   "parentId": "123e4567-e89b-12d3-a456-426614174000",
141   "parentTask": {
142     "id": "123e4567-e89b-12d3-a456-426614174000",
143     "name": "Design",
144     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
145     "userId": "123e4567-e89b-12d3-a456-426614174000",
146     "assigneeIds": [
147       "string"
148     ]
149   },
150   "isSubtask": true,
151   "numberOfSubtasks": 1,
152   "hasAttachment": false,
153   "lists": [
154     {
155       "id": "123e4567-e89b-12d3-a456-426614174000",
156       "createdOn": "2021-03-22T15:00:00Z",
157       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
158       "updatedOn": "2021-03-22T16:30:00Z",
159       "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
160       "name": "Product and Marketing To-Dos",
161       "order": 2,
162       "plannedDuration": 1,
163       "totalPlannedDuration": 1,
164       "totalPlannedDurationWithHierarchy": 1,
165       "isArchived": false,
166       "isHiddenForConnectUsers": true,
167       "orderOfTask": 5
168     }
169   ],
170   "userId": "123e4567-e89b-12d3-a456-426614174000",
171   "tags": [
172     {
173       "id": "123e4567-e89b-12d3-a456-426614174000",
174       "name": "Design",
175       "color": "purple"
176     }
177   ],
178   "createdOn": "2022-02-29T18:52:54.945Z",
179   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
180   "updatedOn": "2020-02-30T18:52:54.945Z",
181   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
182   "closedOn": "2024-01-15T09:30:00Z",
183   "closedBy": "123e4567-e89b-12d3-a456-426614174000",
184   "order": 2,
185   "subtaskOrder": 1,
186   "createdFromTaskId": "123e4567-e89b-12d3-a456-426614174000",
187   "isRecurring": true,
188   "customFields": [
189     {
190       "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
191       "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
192       "clientIdValue": "123e4567-e89b-12d3-a456-426614174000",
193       "numberValue": 123.45,
194       "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
195       "selectionOption": {
196         "value": "Website Design",
197         "order": 0,
198         "id": "123e4567-e89b-12d3-a456-426614174000",
199         "color": "purple"
200       },
201       "textValue": "S1: Business Critical",
202       "dateValue": "2024-01-15T09:30:00Z",
203       "booleanValue": true
204     }
205   ],
206   "trackedDuration": 1200,
207   "totalTrackedDuration": 1200,
208   "totalPlannedDuration": 21600,
209   "resourceVersion": 637825154598030700,
210   "checklistItemsDoneCount": 2,
211   "checklistItemsCount": 5,
212   "taskSchedulesCount": 1,
213   "isCompletelyScheduled": true,
214   "commentCount": 1,
215   "entityId": "123e4567-e89b-12d3-a456-426614174000",
216   "remainingDuration": 10500,
217   "totalRemainingDuration": 1
218 }

To update the task, the user needs to be the assignee of the task or ‘ProjectPlanning’ permissions in general or in the project the task is related to.

Required Permissions

Any authenticated user.

To update the task, the user needs to be the assignee of the task or 'ProjectPlanning' permissions in general or in the project the task is related to. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Path parameters

taskIdstringRequiredformat: "uuid"

The id of the task.

Request

The model describing the task updates.

namestringRequired0-1000 characters

The name of the task. Max allowed length: 1000 characters.

descriptionstring or nullOptional0-25000 characters

The description of the task. Max allowed length: 25000 characters.

isPrioboolean or nullOptional

Whether this task is marked as priority.

startOndatetime or nullOptional

The expected start date and time of the task.

dueOndatetime or nullOptional

The expected due date and time of the task.

laneOrderinteger or nullOptional

The lane order defines the vertical position in the task board.

plannedDurationinteger or nullOptional

The expected planned workload of the task, in seconds.

Response

namestring0-1000 characters

The name of the task. Max allowed length: 1000 characters.

descriptionstring or null0-25000 characters

The description of the task. Max allowed length: 25000 characters.

isPrioboolean or null

Whether this task is marked as priority.

startOndatetime or null

The expected start date and time of the task.

dueOndatetime or null

The expected due date and time of the task.

laneOrderinteger or null

The lane order defines the vertical position in the task board.

plannedDurationinteger or null

The expected planned workload of the task, in seconds.

idstring or nullformat: "uuid"

The Id of the task.

taskNumberinteger or null

The sequential task number within the project. Unique within the project, never reused even after deletion.

taskIdentifierstring or null<=40 characters

The full task identifier combining project key and task number (e.g., “NIKE-42”). Maintained by the service layer, updated when project key changes.

isExternalboolean or null

True if the model is coming from an external workspace (awork Connect). False otherwise.

createdViastring or null

The origin of the task. From which 'flow' the task was created. Automatically set by the backend.

isHiddenForConnectUsersboolean or null

True if the task is hidden for external workspace users. False otherwise.

baseTypeenum or null

The base type of the task. Can be 'private' for a private task or 'projecttask' for a project task.

Allowed values:

taskStatusIdstring or nullformat: "uuid"

The id of the status for this task.

taskStatusobject or null

typeOfWorkIdstring or nullformat: "uuid"

The id of the type of work of this task.

typeOfWorkobject or null

assigneeslist of objects or null

The list assigned users of this task, or empty if not user was assigned.

projectIdstring or nullformat: "uuid"

The id of the project this task is assigned to. Only set if this is a project task. In this case, it is equal to the EntityId.

projectobject or null

correlationIdstring or nullformat: "uuid"

The correlation id between parent and subtasks, meaning it's either the ParentId or its own Id.

parentIdstring or nullformat: "uuid"

The id of the parent task this of this subtask. Only set if this is a subtask.

parentTaskobject or null

isSubtaskboolean or null

True if the task is a subtask.

numberOfSubtasksinteger or null

The number of subtasks of this task. Null if it's not a parent task.

hasAttachmentboolean or null

Whether this task has an attachment.

listslist of objects or null

The lists to which the task is assigned to.

userIdstring or nullformat: "uuid"

The id of the user of the private task.

tagslist of objects or null

The list of tags.

createdOndatetime or null

The date this task was created.

createdBystring or nullformat: "uuid"

The id of the user who created this task.

updatedOndatetime or null

The date this task was last modified.

updatedBystring or nullformat: "uuid"

The id of the user who last modified this task.

closedOndatetime or null

The date the task was set to closed.

closedBystring or nullformat: "uuid"

The user who closed the task.

orderdouble or null

The order of the task in a task status column.

subtaskOrderdouble or null

The order of the subtask relative to its parent task.

createdFromTaskIdstring or nullformat: "uuid"

When the task was created by a recurrency rule, the id is the link to the template of which the task was created.

isRecurringboolean or null

If the task is a recurrency template (used to create new tasks by a recurrency rule), the flag is true.

customFieldslist of objects or null

Custom fields of the task.

trackedDurationinteger or null

The summed up duration of all time trackings for this task.

totalTrackedDurationinteger or null

The summed up duration of all time trackings for this task, including subtasks.

totalPlannedDurationinteger or null

The total planned workload of the task, in seconds, including subtasks.

resourceVersionlong or null

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

checklistItemsDoneCountinteger or null

The number of checklist items marked as done.

checklistItemsCountinteger or null

The total number of checklist items.

taskSchedulesCountinteger or null

The number of task schedules for this task.

isCompletelyScheduledboolean or null

Whether this task is completed scheduled.

commentCountinteger or null

The number of comments on this task.

entityIdstring or nullformat: "uuid"Deprecated

The id of the entity this task is assigned to. This is the id of the project if this is a project task, or the id of a user if this is a private task. See 'BaseType' for supported types.

remainingDurationinteger or nullDeprecated

The expected remaining duration from the original planned effort of the task, in seconds. Null if the user has no permissions to see time tracking information.

totalRemainingDurationinteger or nullDeprecated

The total remaining duration from the original planned effort of the task, in seconds, including subtasks.

Required Permissions

Authentication

Path parameters

Request

Response

Errors

Required Permissions