Skip to navigation

Set a task's status

Beta

Mark a task done, or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who and when; reopening clears both.

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.
statusenumRequired
open or done.
Allowed values:

Response

The task, 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

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