create_signed_documents_delivery_draft

Build signed documents delivery draft

Build the delivery draft for a signed document package (a seller's addendum, a lender form, or another PDF the buyer signed on Ohvii through the document_signing ceremony), exactly as the signing workspace's Review and send does. Pass the package id and its signed document ids from get_signing_ceremony_handoff; for a disclosure package the buyer signed on its disclosure page, the disclosure package id (list_disclosure_packages) works as the package id and the signed file ids come from list_signing_evidence. Returns the draftId and its draftRevisionId to feed straight to prepare_transaction_email_send so the buyer reviews the exact email; a signed disclosure package before the offer goes out returns bundle_with_offer instead, because it rides with the offer packet. This creates a draft only and sends nothing; a repeat returns the package's existing draft. It takes only a document_signing package or a disclosure package: a signed counter response, repair request, contingency removal, addendum draft, or other Ohvii form already has its own delivery email draft in list_transaction_email_drafts, so send that with prepare_transaction_email_send instead.

Effect: Draft or workspace edit
Required scopes: workspace:write
Workflow stages: closing, offer, transaction
Data classes: documents
Operation cost: 2 weighted units; additional domain limits may apply.
Configurations: Standard, Buyer UI v2
Muse proposal: Write. Creates or updates draft, document, or workspace data within the authorized workflow. 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
`idempotencyKey`string	Yes	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.
`packageId`string	Yes	Pattern validation applies; see the raw schema.
`signedDocumentIds`array<string>	Yes	Minimum items: 1. Maximum items: 100.
signedDocumentIds: nested contract Array item contract Pattern validation applies; see the raw schema.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field	Required	Meaning and constraints
`deliveryMode`string	Yes	Allowed: "bundle_with_offer", "follow_up", "separate".
`draftId`string \| null	Yes	Must match at least one alternative.
draftId: nested contract Alternative 1: string Pattern validation applies; see the raw schema. Alternative 2: null
`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
`idempotencyKey`string	Yes	Format: uuid. Pattern validation applies; see the raw schema.
`packageId`string	Yes	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": {
    "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."
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "signedDocumentIds": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]{1,200}$"
      }
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "idempotencyKey",
    "packageId",
    "signedDocumentIds",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "deliveryMode": {
      "type": "string",
      "enum": [
        "bundle_with_offer",
        "follow_up",
        "separate"
      ]
    },
    "draftId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{1,200}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "draftRevisionId": {
      "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)$"
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "deliveryMode",
    "draftId",
    "draftRevisionId",
    "idempotencyKey",
    "packageId",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.