Personal Tasks

Update a task

Changed on

Update a task by its ID

put/v1/tasks/{taskId}

Request

  • Base URL
    https://api.astravue.com
  • URL
    https://api.astravue.com/v1/tasks/{taskId}
  • Auth
    none declared. Required headers: X-Org-Id

Path parameters

taskIdinteger required

ID of the task to be updated

Headers

X-Org-Idinteger required

Organization ID

Request body

taskTitlestring

Title of the task. Optional for updates.

descriptionstring

Description of the task. Optional for updates.

ownersinteger[]

List of owner IDs assigned to the task. Optional for updates.

startDatestring date-time

Start date of the task. Optional for updates.

dueDatestring date-time

Due date of the task. Optional for updates.

noOfDaysinteger

Duration in working days. When sent together with startDate or dueDate, the missing date is recomputed honouring the organisation's operational hours.

completioninteger

Completion percentage of the task. Must be between 0 and 100. Optional for updates.

statusstring

Status of the task. Optional for updates.

prioritystring

Priority of the task. Optional for updates.

tagsstring[]

List of tags associated with the task. Optional for updates.

Example request

{
  "taskTitle": "Update authentication module",
  "description": "This task involves updating the authentication module for the application.",
  "owners": [
    1,
    2,
    3
  ],
  "startDate": "2023-10-01T00:00:00.000Z",
  "dueDate": "2023-10-15T00:00:00.000Z",
  "noOfDays": 5,
  "completion": 75,
  "status": "Completed",
  "priority": "Medium",
  "tags": [
    "frontend",
    "low-priority"
  ]
}

Response

Task updated successfully

Changes

  • 237f5bbd4029Revision changes
    • breaking

      removed the media type application/hal+json for the response with the status

    • info

      added the media type application/vnd.hal+json for the response with the status