delete_transaction_documents

Delete transaction documents

Delete up to twenty of the buyer's own uploads from the active transaction: the stored file and its record are removed for good. Only files the buyer uploaded that no counter, amendment, deadline or sent email relies on can go; signed records, listing-side files and relied-on uploads are refused as a whole, so nothing is deleted when any named id is one (the buyer can remove a file themselves on Ohvii); ids the list no longer holds are reported as missing. Call it only when the buyer asked in this conversation to remove those specific documents, after naming them. Reuse mutationId only for an exact retry; it returns the same receipt. It contacts nobody and sends nothing.

Effect: Consequential change
Required scopes: documents:write
Workflow stages: closing, offer, transaction
Data classes: documents, 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
`documentIds`array<string>	Yes	Minimum items: 1. Maximum items: 20.
documentIds: nested contract Array item contract Pattern validation applies; see the raw schema.
`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.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field	Required	Meaning and constraints
`deletedDocumentIds`array<string>	Yes	Maximum items: 20.
deletedDocumentIds: nested contract Array item contract Pattern validation applies; see the raw schema.
`missingDocumentIds`array<string>	Yes	Maximum items: 20.
missingDocumentIds: nested contract Array item contract Pattern validation applies; see the raw schema.
`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.
`replayed`boolean	Yes	No additional description in the contract.
`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": {
    "documentIds": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,200}$"
      }
    },
    "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": [
    "documentIds",
    "mutationId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deletedDocumentIds": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,200}$"
      }
    },
    "missingDocumentIds": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,200}$"
      }
    },
    "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."
    },
    "replayed": {
      "type": "boolean"
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "deletedDocumentIds",
    "missingDocumentIds",
    "mutationId",
    "replayed",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.