archive_transaction

Archive or restore transaction

Archive a finished or abandoned transaction so it leaves the buyer's active list, or restore one that was archived. Nothing is deleted. A cancelled purchase can be archived only once the cancellation is fully executed, and an archived transaction leaves list_transactions until restored; find it again with list_transactions include "ended". While archived it is read-only: get_transaction_context and the document, message, email-draft, and signing reads still work, and every other tool refuses it. Do this only when the buyer asks.

Effect: Consequential change
Required scopes: workspace:write
Workflow stages: closing, transaction
Data classes: transaction
Operation cost: 3 weighted units; additional domain limits may apply.
Configurations: Standard, Buyer UI v2
Muse proposal: Sensitive write. Changes or removes a record, recipient, or permission the buyer relies on. Meta makes the final classification during review.

Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.

Input and output contracts

Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.

Input fields

Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.

Field Required Meaning and constraints

archivedboolean Yes No additional description in the contract.

mutationIdstring

Yes

A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label.

Format: uuid.

Pattern validation applies; see the raw schema.

workspaceIdstring

Yes

Pattern validation applies; see the raw schema.

Output fields

Field	Required	Meaning and constraints
`archived`boolean	Yes	No additional description in the contract.
`mutationId`string	Yes	A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label. Format: uuid. Pattern validation applies; see the raw schema.
`schemaVersion`string	Yes	Must be "1".
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Raw input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean"
    },
    "mutationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label."
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "archived",
    "mutationId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "archived": {
      "type": "boolean"
    },
    "mutationId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A fresh random UUID (v4) you generate for this mutation. Send the same UUID only to retry the identical mutation; never a readable label."
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "archived",
    "mutationId",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false
}

Reference 00e5441a095c7e20. Download the full catalog.