Update task
Change a task’s status, priority, assignee, due date, title or other details, or add a note to its history. Send only what changes. Send expectedVersion to make sure nobody changed it since you read it.
/v1/w/{workspace}/tasks/{id}Send an Idempotency-Key. This may answer 202 while it waits for approval.
Path parameters
workspacestringrequiredYour workspace’s address name.
idstringrequiredThe task’s id, like APP-12.
Headers
Idempotency-Keystring8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.
Body
statusenumopen, in_progress, to_test, do_later, done or wont_do.
priorityenumnone, low, medium, high or urgent. Defaults to none.
assigneestringEmail of the member doing it, or an empty string to clear.
titlestringA short summary, up to 140 characters.
descriptionstringThe detail. For bugs: steps, what you expected and what happened.
productstringThe product or project it belongs to, by its three-letter key, like APP. Get Workspace lists them.
surfacestringWhere it happens, like web or pwa. Get Workspace lists each product’s surfaces.
environmentenumBugs only: production, staging or local. Defaults to production.
componentstring | nullexpectedVersionstringThe updatedAt from your last read. If it changed since, nothing is written and you get conflict with the current task.
notestringA note added to the task’s history, such as what you found or did.
parentstring | nullMake it a sub-task of this task.
milestonestring | nullProject milestone id, or null to clear.
sprintstring | nullA sprint id, current, next, or null for the backlog.
dueOnstring | nullThe day it’s due, YYYY-MM-DD.
closeSubtasksenumWhen closing a task: done or wont_do also closes its unfinished sub-tasks.
Response
updatedstringrequireditemobjectrequiredDetails
Change status, priority, assignee, due date, title, description, product, surface, environment or parent, or add a note. Every change is written to the item's activity with the caller as actor. Starting a sub-task also starts its parent when the parent is open.