Project workspace

update-work-item-tool

Update any subset of writable fields on a work item in a single, atomic call.

Updates any subset of writable fields on a work item. All field changes are applied inside a single database transaction — if any field fails validation or its policy check, the entire call aborts and no partial writes are made.

Use the dedicated transition-work-item-status-tool when changing workflow_status_id. This tool deliberately rejects status updates so the transition guard's error path stays distinct from a generic update.

Inputs

NameTypeRequiredDescription
work_item_keystringyesIssue key of the work item to update (e.g. ACM-123).
titlestringnoNew title.
descriptionstring | nullnoNew description.
prioritystring | nullnohighest, high, normal, low, lowest.
due_datestring (Y-m-d) | nullnoDue date, or null to clear.
estimationinteger | nullnoOriginal estimate in minutes.
remaining_estimateinteger | nullnoRemaining estimate in minutes.
work_type_idinteger | nullnoWork type ID.
deadline_idinteger | nullnoDeadline ID.
assignee_idinteger | nullnoAssignee user ID.
sprint_idinteger | nullnoSprint ID, or null to move to the backlog.
parent_idinteger | nullnoParent work item ID, or null to clear.

Permissions

  • project_management::manage_work_items (entry permission).
  • The user must also be allowed to manage the target work item by WorkItemPolicy.

Example

{
  "work_item_key": "ACM-123",
  "title": "Stripe SDK upgrade (v2)",
  "priority": "high",
  "assignee_id": 18,
  "due_date": "2026-06-15"
}

Response

Returns the updated work item snapshot (same shape as get-work-item-by-key-tool) plus an updated_fields array listing the field names that were touched.

Errors

  • An unknown work_item_key returns a validation error.
  • Submitting workflow_status_id is rejected (use the transition tool instead).
  • Submitting no writable fields returns a validation error.
  • A caller without project_management::manage_work_items (or who fails the model policy) receives an authorization error.

On this page