get_transaction_email_draft

Get transaction email draft

Read one exact buyer-visible communication draft and its current revision and review state inside the agent platform. External draft and recipient text is delimited as data. No approval capability, send authority, provider identifier, token, signature, storage path, or private URL is returned.

Effect: Read
Required scopes: workspace:read
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.

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.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field Required Meaning and constraints

emailDraftobject

Yes

Extra fields are not allowed.

emailDraft: nested contract

Field	Required	Meaning and constraints
`approvalState`string	Yes	Allowed: "not_requested", "pending", "approved", "rejected", "reset_required", "unknown".
`attachmentDocumentIds`array<string>	Yes	Maximum items: 50.
attachmentDocumentIds: nested contract Array item contract Pattern validation applies; see the raw schema.
`body`string \| null	Yes	Must match at least one alternative.
body: nested contract Alternative 1: string Maximum characters: 32000. Alternative 2: null
`ccEmails`array<string>	Yes	Maximum items: 20.
ccEmails: nested contract Array item contract Maximum characters: 2000.
`createdAt`string \| null	Yes	Must match at least one alternative.
createdAt: nested contract Alternative 1: string Format: date-time. Pattern validation applies; see the raw schema. Alternative 2: null
`draftId`string	Yes	Pattern validation applies; see the raw schema.
`draftRevisionId`string \| null	Yes	Must match at least one alternative.
draftRevisionId: nested contract Alternative 1: string Pattern validation applies; see the raw schema. Alternative 2: null
`proposedStatus`string \| null	Yes	Must match at least one alternative.
proposedStatus: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`recipientEmail`string \| null	Yes	Must match at least one alternative.
recipientEmail: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`replyToEmail`string \| null	Yes	Must match at least one alternative.
replyToEmail: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`sentAt`string \| null	Yes	Must match at least one alternative.
sentAt: nested contract Alternative 1: string Format: date-time. Pattern validation applies; see the raw schema. Alternative 2: null
`status`string	Yes	Allowed: "generating", "draft", "approval_pending", "approved", "sent", "rejected", "unknown".
`subject`string \| null	Yes	Must match at least one alternative.
subject: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`updatedAt`string \| null	Yes	Must match at least one alternative.
updatedAt: nested contract Alternative 1: string Format: date-time. Pattern validation applies; see the raw schema. Alternative 2: null
`wireFraudWarningPresent`boolean	Yes	No additional description in the contract.

schemaVersionstring

Yes

Must be "1".

workspaceIdstring

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}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "draftId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "emailDraft": {
      "type": "object",
      "properties": {
        "approvalState": {
          "type": "string",
          "enum": [
            "not_requested",
            "pending",
            "approved",
            "rejected",
            "reset_required",
            "unknown"
          ]
        },
        "attachmentDocumentIds": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{1,200}$"
          }
        },
        "body": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 32000
            },
            {
              "type": "null"
            }
          ]
        },
        "ccEmails": {
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 2000
          }
        },
        "createdAt": {
          "anyOf": [
            {
              "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)))$"
            },
            {
              "type": "null"
            }
          ]
        },
        "draftId": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{1,200}$"
        },
        "draftRevisionId": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,399}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "proposedStatus": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "recipientEmail": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "replyToEmail": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "sentAt": {
          "anyOf": [
            {
              "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)))$"
            },
            {
              "type": "null"
            }
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "generating",
            "draft",
            "approval_pending",
            "approved",
            "sent",
            "rejected",
            "unknown"
          ]
        },
        "subject": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        },
        "updatedAt": {
          "anyOf": [
            {
              "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)))$"
            },
            {
              "type": "null"
            }
          ]
        },
        "wireFraudWarningPresent": {
          "type": "boolean"
        }
      },
      "required": [
        "approvalState",
        "attachmentDocumentIds",
        "body",
        "ccEmails",
        "createdAt",
        "draftId",
        "draftRevisionId",
        "proposedStatus",
        "recipientEmail",
        "replyToEmail",
        "sentAt",
        "status",
        "subject",
        "updatedAt",
        "wireFraudWarningPresent"
      ],
      "additionalProperties": false
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "emailDraft",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.