Update task

PATCH/v1/tasks/{taskId}

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
taskIdpathstringYesTask ID
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
titlestringNoDisplay title.
descriptionstringNoHuman-readable description.
projectIdstringNoProject ID.
releaseIdstringNo
statusbacklog | todo | in_progress | blocked | in_review | doneNoCurrent lifecycle status.
prioritylow | medium | high | urgentNo
typetask | subtask | loopNo
taskTypetask | subtask | loopNo
parentTaskIdstringNo
loopobjectNo
loop.enabledbooleanNo
loop.goalstringNoEnd goal the loop should reach.
loop.endGoalstringNoAlias for goal.
loop.progressSignalstringNoObservable signal that shows each iteration is making progress.
loop.verificationCriteriastringNoHow the verifier should judge each iteration.
loop.successCriteriastringNoObjective condition that stops the loop successfully.
loop.maxIterationsintegerNo
loop.noProgressLimitintegerNo
loop.workerAgentIdstringNo
loop.verifierAgentIdstringNo
sprintIdstringNo
assigneeAgentIdstringNo
dependencyIdsstring[]No
linkedThreadIdsstring[]No
lastStartedThreadIdstringNo
scheduledStartAtstringNo
scheduledEndAtstringNo
dueAtstringNo
completedAtstringNoISO 8601 timestamp.
sortOrdernumberNo
metadataobjectNoFree-form metadata object.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Task updatedapplication/json
FieldTypeRequiredDescription
taskobjectNo
task.idstringNoUnique identifier.
task.userIdstringNoUser ID.
task.organizationIdstringNo
task.createdByUserIdstringNo
task.projectIdstringNoProject ID.
task.releaseIdstringNo
task.titlestringNoDisplay title.
task.descriptionstringNoHuman-readable description.
task.statusbacklog | todo | in_progress | blocked | in_review | doneNoCurrent lifecycle status.
task.prioritylow | medium | high | urgentNo
task.typetask | subtask | loopNo
task.parentTaskIdstringNo
task.loopobjectNo
task.loop.enabledbooleanNo
task.loop.goalstringNoEnd goal the loop should reach.
task.loop.endGoalstringNoAlias for goal.
task.loop.progressSignalstringNoObservable signal that shows each iteration is making progress.
task.loop.verificationCriteriastringNoHow the verifier should judge each iteration.
task.loop.successCriteriastringNoObjective condition that stops the loop successfully.
task.loop.maxIterationsintegerNo
task.loop.noProgressLimitintegerNo
task.loop.workerAgentIdstringNo
task.loop.verifierAgentIdstringNo
task.sprintIdstringNo
task.assigneeAgentIdstringNo
task.dependencyIdsstring[]No
task.linkedThreadIdsstring[]No
task.lastStartedThreadIdstringNo
task.scheduledStartAtstringNo
task.scheduledEndAtstringNo
task.dueAtstringNo
task.completedAtstringNoISO 8601 timestamp.
task.sortOrdernumberNo
task.metadataobjectNoFree-form metadata object.
task.createdAtstringNoISO 8601 timestamp.
task.updatedAtstringNoISO 8601 timestamp.
409Task cannot be updated because dependencies, subtasks, or task relationships block the requested state
None.
Update task
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow