Skip to content
SHAMPOO

Tool catalogue

task_cancel

Write · Ordinary · Tasks and notes

task_cancel

  • Category: tasks
  • Access: write
  • Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Cancel a task or note (distinct from completing).

Arguments

Required: task_id.

  • task_id. Note: UUID of the task or note to cancel.

Result

JSON object with cancelled (id), status cancelled and previous_status, or unchanged 1 when already cancelled.

Boundaries

Only the addressed task visible under the caller's project grants is touched; foreign projects read as not found.

Lifecycle / side effects

Explicit cancelled transition through the canonical mutation path, distinct from completing.

Errors

Missing/foreign id reads as not found. Done or archived rows fault (restore/reconsider first); already-cancelled rows are a successful no-op. Failures move nothing (atomic).

Example

{
  "task_id": "<uuid>"
}

Result shape:

{
  "cancelled": "<uuid>",
  "status": "cancelled"
}

See also

task_complete, update_task, query_tasks, archive_task.

On this page