Update a task

Path Params

task_id

uuid

required

The unique identifier of the task.

Body Params

At least one field must be supplied.

name

string

The name of the task.

description

string | null

null is allowed. A longer description of the task.

priority

string

The priority key of the task.

status

string

The status key of the task. Set this to a cancelled-category status to cancel the task. A task in a done-category status can be moved again: moving it to a status that reopens the task (anything outside the done and cancelled categories) clears completed_at, while moving it to a second done-category status or cancelling it keeps the original completion date. Cancelling is final: a task in a cancelled-category status cannot be transitioned again.

reference_type

string

enum

The type of entity to link the task to.

Allowed:

reference_id

string | null

The entity to link the task to: its ID, or its policy, claim or complaint number. A number is resolved to the entity's ID, and the ID is stored. When reference_type is omitted, the task's current reference type is used; a task with none returns 400. Returns 404 when no entity matches, and 409 when a number matches more than one.

due_date

date-time | null

The date and time by which the task is due.

sla_hours

integer

≥ 1

The number of hours, from creation, within which the task is due.

200Success