API Docs / Schemas / CreateTaskItemRequest

CreateTaskItemRequest

Request model for creating a new task

Properties

Name Type Description
name*string

The name of the task

The name of the task

descriptionstring

The description of the task

The description of the task

status*enum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

timeEstimateMinutesinteger

The estimated time to complete the task, in whole minutes.

The estimated time to complete the task, in whole minutes.

startDate*string

When the task starts

When the task starts

dueDate*string

When the task is due

When the task is due

statutoryDueDatestring

The statutory due date for compliance tasks (if applicable)

The statutory due date for compliance tasks (if applicable)

startTimestring

Time of day on the start date. Omit for 09:00.

Time of day on the start date. Omit for 09:00.

dueTimestring

Time of day on the due date. Omit for 09:00.

Time of day on the due date. Omit for 09:00.

clientCodesarray of string

The codes of the clients this task is associated with (optional)

The codes of the clients this task is associated with (optional)

primaryClientCodestring

The code of the primary client for this task (optional)

The code of the primary client for this task (optional)

assignedUserCodestring

The code of the user to assign the task to (optional)

The code of the user to assign the task to (optional)

assignedTeamCodestring

The code of the team to assign the task to (optional)

The code of the team to assign the task to (optional)

clientBillableServiceCodestring

The code of the client billable service this task relates to (optional)

The code of the client billable service this task relates to (optional)

categoryCodestring

The code of the category for this task (optional)

The code of the category for this task (optional)

checklistarray of ChecklistItemDto

Checklist items for this task

Checklist items for this task

isAutomationDisabledboolean

Automation switch. On create, null lets Sodium decide: a task starting today or in the past
lands with automation off, so creating it never runs workflow steps as a side effect. An
explicit value wins over that rule - true is off whatever the dates, false is on.
On update, null leaves it unchanged; a different value switches automation, which on the way
on runs any steps that are ready.

Automation switch. On create, null lets Sodium decide: a task starting today or in the past
lands with automation off, so creating it never runs workflow steps as a side effect. An
explicit value wins over that rule - true is off whatever the dates, false is on.
On update, null leaves it unchanged; a different value switches automation, which on the way
on runs any steps that are ready.

JSON Example

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

Used By Operations