update_task
Update a task's mutable fields such as status, title, or deadline. For recurring tasks, specify scope to apply changes to one, following, or all instances.
Instructions
Patch mutable fields on a task.
task_id accepts any reference form — UUID, sequence shorthand
(#123, personal-org only), canonical ref (acme-123), or app URL
— and is resolved to a UUID before the update.
status must be one of open, in-progress, in-review,
done, dropped, pruned. The backend rejects completing a
task while any of its children are still active.
Pass None explicitly to clear a field (e.g. complete_by=None
removes the deadline). Omitting a parameter leaves it unchanged.
recurrence sets or clears a repeat schedule (see create_task).
recurring_type can be "chore", "habit", or "event"
(see create_task for details). Pass None to clear.
For recurring tasks, if you change title, description, labels, or
complete_by, you MUST also provide recurring_scope:
"this" (single instance), "following" (this and future),
or "all" (entire series). "this" and "following" also
require recurrence_id (the ISO start time of the instance).
If the task is recurring and scope is missing, the call will fail
with a message asking you to specify the scope — ask the user
which option they prefer.
v0.2 optional field:
occurrence_id: when this Task is a materialized subtask of a recurring entity's occurrence, the Occurrence id it belongs to. Normal tasks omit this field.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes | ||
| title | No | ||
| description | No | ||
| status | No | ||
| labels | No | ||
| assignee | No | ||
| complete_by | No | ||
| productive | No | ||
| desire | No | ||
| recurrence | No | ||
| recurring_scope | No | ||
| recurrence_id | No | ||
| recurring_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |