Skip to navigation
Alpha APIActions

Update Task

View as Markdown

Edit an existing task by its board identifier (for example ‘ACME-5’, or just 5; the prefix is whatever this vault uses) or by taskId from list_tasks. Fields: status, named owner, t-shirt estimate, priority, labels, checklist, due date, milestone, title and description. Pass null to clear a clearable field (estimate, dueDate, milestoneId, assigneeName, description). Requires a manager API key.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

identifierstring or doubleOptional

Board reference: e.g. ‘ACME-5’, or just 5

taskIdstringOptional

Task id from list_tasks (alternative to identifier)

titlestringOptional
descriptionstring or nullOptional
statusenumOptional
Allowed values:
assigneeNamestring or nullOptional

Responsible person or company; null clears it

estimateenumOptional

T-shirt effort size; null clears it

Allowed values:
priorityenumOptional
Allowed values:
labelslist of stringsOptional

Replaces the label list ([] clears)

checklistlist of objectsOptional

Replaces the checklist ([] clears)

dueDatestring or nullOptional

ISO date; null clears

milestoneIdstring or nullOptional

Milestone id from list_milestones; null clears

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Update Task completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error