← Tool reference

prepare_transaction_email_send

Prepare transaction email

Prepare one exact transaction email for the buyer to approve, sealed to the current draft revision. expectedDraftRevisionId is the draftRevisionId the tool that gave you this draft returned, or the one from get_transaction_email_draft; send that value rather than guessing, since a draft whose revision moved is refused as STALE_REVISION. Returns the exact recipient, cc list, subject, body, and attachment names, and onSend: what sending also changes on Ohvii (a walk-away email withdraws the offer and archives the transaction), to tell the buyer with the email. Show all of that to the buyer in this conversation and ask them there, unless they already asked in advance for this specific email to be sent (see send_transaction_email_draft). Nothing is sent by this tool; it only freezes what would be sent.

Effect
Read
Required scopes
communications:send
Workflow stages
closing, offer, transaction
Data classes
communications, transaction
Operation cost
1 weighted units; additional domain limits may apply.
Configurations
Standard, Buyer UI v2
Muse proposal
Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. 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.

Prepare an exact email for review →

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.

FieldRequiredMeaning and constraints
draftIdstringYes

Pattern validation applies; see the raw schema.

expectedDraftRevisionIdstring | nullYes

Must match at least one alternative.

expectedDraftRevisionId: nested contract
Alternative 1: string

Pattern validation applies; see the raw schema.

Alternative 2: null

idempotencyKeystringYes

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

Format: uuid.

Pattern validation applies; see the raw schema.

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Output 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.

FieldRequiredMeaning and constraints
idempotencyKeystringYes

Format: uuid.

Pattern validation applies; see the raw schema.

onSendstring | nullYes

Must match at least one alternative.

onSend: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 300.

Alternative 2: null

preparedActionobjectYes

Extra fields are not allowed.

preparedAction: nested contract
FieldRequiredMeaning and constraints
attachmentsarray<object>Yes

Maximum items: 20.

attachments: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
contentTypestringNo

Maximum characters: 160.

documentIdstringYes

Pattern validation applies; see the raw schema.

filenamestringYes

Minimum characters: 1.

Maximum characters: 1024.

sha256stringNo

Pattern validation applies; see the raw schema.

sizeBytesintegerNo

Minimum: 0.

Maximum: 9007199254740991.

bodystringYes

Minimum characters: 1.

Maximum characters: 12000.

ccEmailsarray<string>Yes

Maximum items: 10.

ccEmails: nested contract
Array item contract

Minimum characters: 1. Maximum characters: 2000.

draftIdstringYes

Pattern validation applies; see the raw schema.

draftRevisionIdstringYes

Pattern validation applies; see the raw schema.

expiresAtstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

preparedActionIdstringYes

Format: uuid.

Pattern validation applies; see the raw schema.

preparedAtstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

recipientEmailstringYes

Minimum characters: 1.

Maximum characters: 2000.

replyToEmailstring | nullYes

Must match at least one alternative.

replyToEmail: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 2000.

Alternative 2: null

subjectstringYes

Minimum characters: 1.

Maximum characters: 1024.

schemaVersionstringYes

Must be "1".

selfSendCcAddressstring | nullYes

Must match at least one alternative.

selfSendCcAddress: nested contract
Alternative 1: string

Maximum characters: 320.

Alternative 2: null

workspaceIdstringYes

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"
        }
      ]
    },
    "idempotencyKey": {
      "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 request. Send the same UUID only to retry the identical request; never a readable label."
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "draftId",
    "expectedDraftRevisionId",
    "idempotencyKey",
    "workspaceId"
  ],
  "additionalProperties": false
}
Full output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "idempotencyKey": {
      "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)$"
    },
    "onSend": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 300
        },
        {
          "type": "null"
        }
      ]
    },
    "preparedAction": {
      "type": "object",
      "properties": {
        "attachments": {
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "contentType": {
                "type": "string",
                "maxLength": 160
              },
              "documentId": {
                "type": "string",
                "pattern": "^[A-Za-z0-9_-]{1,200}$"
              },
              "filename": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1024
              },
              "sha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "sizeBytes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "documentId",
              "filename"
            ],
            "additionalProperties": false
          }
        },
        "body": {
          "type": "string",
          "minLength": 1,
          "maxLength": 12000
        },
        "ccEmails": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          }
        },
        "draftId": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{1,200}$"
        },
        "draftRevisionId": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,399}$"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "preparedActionId": {
          "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)$"
        },
        "preparedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "recipientEmail": {
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        },
        "replyToEmail": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "subject": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1024
        }
      },
      "required": [
        "attachments",
        "body",
        "ccEmails",
        "draftId",
        "draftRevisionId",
        "expiresAt",
        "preparedActionId",
        "preparedAt",
        "recipientEmail",
        "replyToEmail",
        "subject"
      ],
      "additionalProperties": false
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "selfSendCcAddress": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 320
        },
        {
          "type": "null"
        }
      ]
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "idempotencyKey",
    "onSend",
    "preparedAction",
    "schemaVersion",
    "selfSendCcAddress",
    "workspaceId"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.