PatchTaskItemRequest - SodiumHQ API Schema

Partial update for a task, following JSON Merge Patch: send only the fields to change.
A field left out of the body is not touched, so a quick action never overwrites details it did not
know about, such as the description. A field sent as null is cleared, for the fields that can be
cleared. The name, status, dates and times are required on a task, so sending one of those as
null is rejected.

Properties

Name	Type	Description
name	string	The name of the task. Required, so it cannot be cleared or blank.
The name of the task. Required, so it cannot be cleared or blank.
description	string	The description of the task. Null clears it.
The description of the task. Null clears it.
status	enum	NotStarted InProgress Blocked Completed Skipped
NotStarted InProgress Blocked Completed Skipped
startDate	string	When the task starts. Required, so it cannot be cleared.
When the task starts. Required, so it cannot be cleared.
dueDate	string	When the task is due. Required, so it cannot be cleared.
When the task is due. Required, so it cannot be cleared.
startTime	string	Time of day on the start date. Cannot be cleared.
Time of day on the start date. Cannot be cleared.
dueTime	string	Time of day on the due date. Cannot be cleared.
Time of day on the due date. Cannot be cleared.
statutoryDueDate	string	The statutory due date for compliance tasks. Null clears it.
The statutory due date for compliance tasks. Null clears it.
timeEstimateMinutes	integer	The estimated time to complete the task, in whole minutes. Null clears it.
The estimated time to complete the task, in whole minutes. Null clears it.
checklist	array of ChecklistItemDto	The checklist, replacing the current one. Null or an empty list clears it.
The checklist, replacing the current one. Null or an empty list clears it.
clientCodes	array of string	The codes of the clients on the task, replacing the current ones. The primary client always stays on the task, so null or an empty list leaves just the primary client. To remove every client, clear the primary client too.
The codes of the clients on the task, replacing the current ones. The primary client always stays on the task, so null or an empty list leaves just the primary client. To remove every client, clear the primary client too.
primaryClientCode	string	The code of the primary client. Null clears it, but a task never has only secondary clients, so if it still has clients the first of them becomes primary. Changing the primary client also clears the task's service and pipeline links, because they belong to a client, unless a service code is sent.
The code of the primary client. Null clears it, but a task never has only secondary clients, so if it still has clients the first of them becomes primary. Changing the primary client also clears the task's service and pipeline links, because they belong to a client, unless a service code is sent.
clientBillableServiceCode	string	The code of the client billable service the task relates to. Null clears it.
The code of the client billable service the task relates to. Null clears it.
assignedUserCode	string	The code of the user the task is assigned to. Null unassigns it.
The code of the user the task is assigned to. Null unassigns it.
assignedTeamCode	string	The code of the team the task is assigned to. Null removes the team.
The code of the team the task is assigned to. Null removes the team.
categoryCode	string	The code of the task's category. Null clears it.
The code of the task's category. Null clears it.
moveWorkflowStepDates	boolean	When the start or due date changes, whether the task's dated workflow steps move with it (their planned dates are worked out again from their timings). Defaults to true when omitted or null.
When the start or due date changes, whether the task's dated workflow steps move with it (their planned dates are worked out again from their timings). Defaults to true when omitted or null.

JSON Example

{
  "name": "string",
  "description": "string",
  "status": "NotStarted",
  "startDate": "2024-01-01",
  "dueDate": "2024-01-01"
}

Used By Operations

PATCH Patch TaskItem
/tenants/{tenant}/tasks/{code}