Skip to navigation
Project ManagerTasks

PM · Tasks · Update task fields; supports inline assignee/tag diffs and status moves

View as Markdown

Partial update for a task. All fields optional. To move the task to a different status (column), pass status with the destination status UUID. Composite fields assignees_add/assignees_remove and tags_add/tags_remove are handled by the middleware — they trigger sub-resource calls automatically. description is converted to a Quill Delta (rich_description) by the toolkit.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired
Task UUID or slug.

Headers

OrganizationstringOptional

Workspace (organization) ID the request is scoped to.

SpacestringOptional

Optional sub-space ID for further scoping inside the workspace.

Request

This endpoint expects an object.
titlestringOptional<=2048 characters
descriptionstringOptional

Plain text task description. This is the field agents and CLI users should set. The toolkit converts it to a Quill Delta and writes rich_description automatically.

rich_descriptionmap from strings to anyOptional

INTERNAL — Quill Delta representation. Set automatically by the toolkit when you pass description. Do not pass directly unless you have a pre-built Delta and know what you're doing.

statusstringOptionalformat: "uuid"

Move task to a new status (on the same or different board).

start_datedatetime or nullOptional
due_datedatetime or nullOptional
priorityintegerOptional
completebooleanOptional
Marking a task complete is rejected if the task has incomplete blockers or a running timer.
estimated_hoursdouble or nullOptional
orderintegerOptional
Pass to reposition the task inside its status.
extramap from strings to anyOptional
custom_fieldsmap from strings to anyOptional
assignees_addlist of integersOptional

Integer user IDs to add as assignees (get from listWorkspaceMembers). Toolkit calls POST /tasks/{id}/assignees/ with {"add": [...]} after the PATCH.

assignees_removelist of integersOptional

Integer user IDs to remove from assignees (get from listWorkspaceMembers). Toolkit calls POST /tasks/{id}/assignees/ with {"remove": [...]} after the PATCH.

tags_addlist of stringsOptional

Composite field — tag names to add. Toolkit calls POST /tasks/{id}/tags/ with {"add": [...]} after the PATCH.

tags_removelist of stringsOptional

Composite field — tag names to remove. Toolkit calls POST /tasks/{id}/tags/ with {"remove": [...]} after the PATCH.

Response

Task updated.