discard_transaction_email_draft

Discard transaction email draft

Discard one unsubmitted transaction email draft the buyer no longer wants, using its current draftRevisionId and an idempotent mutationId: the draft is archived (never deleted) and leaves every list, exactly as the website's Dismiss does. A draft Ohvii parked behind its own website approval step can be discarded too, which withdraws that request; a sent draft, or one the buyer already approved on the website, cannot. Call it only when the buyer asked here. It contacts nobody.

Effect: Consequential change
Required scopes: workspace:write
Workflow stages: closing, offer, transaction
Data classes: communications, 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
`draftId`string	Yes	Pattern validation applies; see the raw schema.
`expectedDraftRevisionId`string \| null	Yes	Must match at least one alternative.
expectedDraftRevisionId: nested contract Alternative 1: string Pattern validation applies; see the raw schema. Alternative 2: null
`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
`draftId`string	Yes	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.
`schemaVersion`string	Yes	Must be "1".
`status`string	Yes	Must be "discarded".
`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": {
    "draftId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "expectedDraftRevisionId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,399}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "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": [
    "draftId",
    "expectedDraftRevisionId",
    "mutationId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

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

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.