Topolo Docs Topolo Platform
Open workspace

Archive workspace

Archive a Books workspace via the platform workspace lifecycle. Refused with workspace_not_empty while any concern database still holds rows for it.

Outcome

Archive a Books workspace via the platform workspace lifecycle. Refused with workspace_not_empty while any concern database still holds rows for it.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is workspace:delete. Discover the exact granted canonical Books workspace and bind it separately from action input.
  • Approve the actual mutation, accounting inputs and any provider/recipient effects before CLI --confirm or MCP confirm:true. Fixture identifiers and simulated provider responses authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.workspaces.archive --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json
  • Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.
  • workspaceId: Exact granted Books workspace id from canonical Auth workspace discovery; organization membership alone is not a workspace grant.

Request

DELETE /api/workspaces/{workspaceId}

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

FieldRequiredMeaningSchema and constraints
workspaceIdRequiredExact granted Books workspace id from canonical Auth workspace discovery; organization membership alone is not a workspace grant.{"type":"string","minLength":1}

Inspect nested fields and the complete input schema.

Effects

  • Archives the workspace through the platform lifecycle. Refused with workspace_not_empty while any concern database still holds rows for it.

Interpret the response

Read $.workspaceId for the returned workspace identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.workspace.bootstrap and confirm the workspace is no longer returned.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.workspaces.archive --data @payload.json --json
topolo actions plan app_topolo_books.workspaces.archive --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.workspaces.archive --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_books.workspaces.archive",
    "input": {
      "workspaceId": "ws_e2e_muvnp7sp3"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "workspaceId": "ws_01k9m2x8"
}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Refused response · workspace_not_empty

Input · payload.json:

{
  "workspaceId": "ws_e2e_muvnp7qn2"
}

Captured response · HTTP 409

{
  "error": "workspace_not_empty"
}

HTTP 409. SDK error code workspace_not_empty. Inspect the workspace through the declared Books reads. Existing accounting or other local records prevent archive; do not erase the organization as a shortcut.

Refused response · forbidden

Input · payload.json:

{
  "workspaceId": "ws_other"
}

Captured response · HTTP 403

{
  "error": "forbidden"
}

HTTP 403. SDK error code forbidden. The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.

Refused response · workspace_archive_refused

Input · payload.json:

{
  "workspaceId": "ws_e2e_muvnp7sp3"
}

Captured response · HTTP 409

{
  "error": "workspace_archive_refused"
}

HTTP 409. SDK error code workspace_archive_refused. Read the actual Auth/archive refusal and the current workspace. A default workspace or unavailable upstream can refuse archival even after local emptiness checks. Preserve identity and data; do not bypass Auth.

Refused response · workspace_archive_refused

Input · payload.json:

{
  "workspaceId": "ws_e2e_muvnp7sp3"
}

Captured response · HTTP 502

{
  "error": "workspace_archive_refused"
}

HTTP 502. SDK error code workspace_archive_refused. Read the actual Auth/archive refusal and the current workspace. A default workspace or unavailable upstream can refuse archival even after local emptiness checks. Preserve identity and data; do not bypass Auth.

Successful response · HTTP 200

Input · payload.json:

{
  "workspaceId": "ws_e2e_muvnp7sp3"
}

Captured response · HTTP 200

{
  "ok": true,
  "workspaceId": "ws_e2e_muvnp7sp3"
}

HTTP 200. Call app_topolo_books.workspace.bootstrap and confirm the workspace is no longer returned.

Refused response · forbidden

Input · payload.json:

{
  "workspaceId": "ws_e2e_muvnp7sp3"
}

Captured response · HTTP 403

{
  "error": "forbidden"
}

HTTP 403. SDK error code forbidden. The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.

Verify the result

  • Call app_topolo_books.workspace.bootstrap and confirm the workspace is no longer returned.

Errors and recovery

  • auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.
  • workspace_not_empty (HTTP 409): Inspect the workspace through the declared Books reads. Existing accounting or other local records prevent archive; do not erase the organization as a shortcut.
  • forbidden (HTTP 403): The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.
  • workspace_archive_refused (HTTP 409): Read the actual Auth/archive refusal and the current workspace. A default workspace or unavailable upstream can refuse archival even after local emptiness checks. Preserve identity and data; do not bypass Auth.
  • workspace_archive_refused (HTTP 502): Read the actual Auth/archive refusal and the current workspace. A default workspace or unavailable upstream can refuse archival even after local emptiness checks. Preserve identity and data; do not bypass Auth.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

Restoring an archived workspace is a platform operation, not a Books action.

Evidence

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.