ts.tsk.cancel

Cancel a task with a reason.

Cancel a task with a reason.

Requires authentication

Description

Convenience tool to cancel a task. Equivalent to calling ts.tsk.update with status “canceled” and a canceled_reason, but with a simpler interface.

Both id and reason are required.

Parameters

NameTypeRequiredDefaultDescription
idstringYesTask ID to cancel
reasonstringYesReason for cancellation

Response

Returns the task ID and list of fields that were updated.

{
  "id": "tsk_68e9623ade9b1631...",
  "updated_at": "2026-02-16T10:00:00Z",
  "updated_fields": [
    "status",
    "canceled_reason"
  ]
}

Errors

CodeDescription
not_authenticatedNo active login for this session
not_foundTask with this ID does not exist
invalid_inputTask ID or reason is missing
invalid_transitionTask cannot be canceled from its current status

Examples

Cancel a task

Cancel a planned task that is no longer needed.

Request:

{
  "id": "tsk_68e9623ade9b1631...",
  "reason": "Superseded by new approach"
}

Response:

{
  "id": "tsk_68e9623ade9b1631...",
  "updated_at": "2026-02-16T10:00:00Z",
  "updated_fields": [
    "status",
    "canceled_reason"
  ]
}