Skip to navigation
API ReferenceTasks

Update a task

Beta

Change a task: a field left out is kept, and an explicit null clears it (title and status cannot be cleared). Needs edit access, and the task must not be in the trash. Labels and links are replaced whole; links already on it that the caller cannot open are kept. Marking it done records who and when.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
The task's asset id.

Headers

X-Athena-Session-CredentialstringOptional

Request

This endpoint expects an object.
assignee_refstring or nullOptional

user_…, agent_asset_… or me; null assigns it to nobody. The assignee must already be able to open the task.

descriptionstring or nullOptional

New details (markdown); null clears them.

due_datestring or nullOptional

YYYY-MM-DD; null clears the due date and its time.

due_timestring or nullOptional

HH:MM (24-hour); null clears the time and keeps the date.

due_time_zonestring or nullOptional

The IANA time zone of due_time.

labelslist of objects or nullOptional

The full new set of labels; null removes them all.

priorityenum or nullOptional

How much it matters; null is none.

Allowed values:
statusenum or nullOptional

open or done (it cannot be cleared).

Allowed values:
titlestring or nullOptional

A new title (it cannot be cleared).

Response

The task as changed, read as the caller.
assigneeobject or null
Who it is for, or null for nobody.
can_editboolean or null

Whether the caller may change it; null in a list.

completed_atdatetime or null
When it was marked done.
completed_by_refstring or null
Who marked it done.
created_atdatetime or null
created_bystring or null
The user who created it.
descriptionstring or null
Markdown.
due_datestring or null

YYYY-MM-DD, or null.

due_timestring or null

HH:MM (24-hour), or null.

due_time_zonestring or null

The IANA time zone of due_time.

idstring
The task's asset id.
is_archivedboolean
Whether it is in the trash.
labelslist of objects
priorityenum
Allowed values:
statusenum
Allowed values:
titlestring
updated_atdatetime or null
workspace_idstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error