Sign in
Task

Update a task. A full replacement: omitted fields are cleared. `complete` true completes the task and stamps `completedUtc` and `completedBy`; false re-opens it and clears both. `sequence` is the public reorder — a value of 1 or more moves the task to that step, alongside any task already there; omitted or below 1 leaves it where it is. `relatedRecord` is ignored: a task stays on the record it was created on.

put/api/tasks/{id}

Path parameters

idstring required

Request body

titlestring required

What the task is. Required

descriptionstring nullable

A longer description of the task

notesstring nullable

Free-text notes on the task

dueDateUtcstring date-time nullable

When the task is due (UTC)

assignedToUserIdstring nullable

The user to assign the task to. Must resolve to a user

taskGroupIdstring nullable

The group to file the task under. Must resolve to an active change order task group

completeboolean

Whether the task is complete. Setting it true completes the task and stamps completedUtc and completedBy; setting it false re-opens the task and clears both

sequenceinteger nullable

The step the task should sit at. A value of 1 or more places it at that step, alongside any task already there. Null or a value below 1 appends it after the last step on a create and leaves it where it is on an update

Response

The updated task

idstring nullable

The id of the task

titlestring nullable

What the task is

descriptionstring nullable

A longer description of the task

notesstring nullable

Free-text notes on the task

sequenceinteger

The step the task sits at within its record's task list. Tasks sharing a step are parallel work, so a step is not unique within a record

dueDateUtcstring date-time nullable

When the task is due (UTC), or null when it carries no date

completeboolean

Whether the task is complete

completedUtcstring date-time nullable

When the task was completed (UTC). Server-stamped when the task is first marked complete and cleared when it is re-opened. Read-only

attachmentCountinteger

How many attachments the task carries

Changes