v2

latestOpenAPI 3.0.12026-07-31690160432.4 KB
Personal Subtasks

Update a subtask for a personal task

Update an existing subtask for a given personal task

put/v1/tasks/{parentTaskId}/subtasks/{subtaskId}

Path parameters

parentTaskIdinteger required

ID of the parent task

subtaskIdinteger required

ID of the subtask to update

Headers

X-Org-Idinteger required

Organization ID

Request body

taskTitlestring

Title of the subtask. Optional for updates.

descriptionstring

Description of the subtask. Optional for updates.

ownersinteger[]

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

startDatestring date-time

Start date of the subtask. Optional for updates.

dueDatestring date-time

Due date of the subtask. 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 subtask. Must be between 0 and 100. Optional for updates.

statusstring

Status of the subtask. Optional for updates.

prioritystring

Priority of the subtask. Optional for updates.

tagsstring[]

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

Example request

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

Response

Subtask updated successfully

successboolean

Indicates if the operation was successful

messagestring

Message describing the result of the operation

codeinteger

HTTP status code of the response

timestampstring date-time

Timestamp of the response

Example response

{
  "success": true,
  "message": "Operation completed successfully",
  "code": 200,
  "timestamp": "2023-01-01T12:00:00Z"
}