ts.edv.archive

Archive an endeavour (cancels non-terminal tasks).

Archive an endeavour (cancels non-terminal tasks).

Requires authentication

Description

Archives an endeavour and cancels all non-terminal tasks within it.

Use confirm=false (default) for a dry-run that shows what would be affected. Use confirm=true to execute the archive operation.

Parameters

NameTypeRequiredDefaultDescription
idstringYesEndeavour ID
reasonstringYesReason for archiving
confirmbooleanfalseExecute the archive (false = dry-run)

Response

Returns the archive result or dry-run summary.

{
  "archived": true,
  "id": "edv_bd159eb7bb9a877a...",
  "tasks_cancelled": 3
}

Errors

CodeDescription
not_authenticatedNo active login for this session
not_foundEndeavour not found
forbiddenInsufficient privileges