← Tool reference

draft_addendum_document

Draft addendum

Draft an addendum to the purchase agreement from the buyer's requested change, exactly as Ohvii's own assistant does: write each modification as a complete, self-contained clause in plain, enforceable language (for example "Seller to credit Buyer $5,000 at close of escrow toward roof repairs."), with a short summary (one or two sentences, at most 300 characters). Each clause is at most 600 characters and an addendum holds at most 20 clauses; split a longer clause into consecutive clauses. For a contingency-extension request, include contingencyExtensions with one entry per contingency the addendum moves (contingency and proposed deadline; a single contingencyExtension is also accepted); Ohvii reads each current deadline from the transaction and refuses a date that is not later, and each row's request is then tracked and confirmed on its own with prepare_contingency_extension_agreement. An addendum never removes a contingency (that happens only on Ohvii's contingency removal form); a removal offered as consideration is written as a promise to deliver the signed removal form upon the seller's signature. Drafting and signing record no term: document.termsToRecord names the contract terms the clauses appear to change (a credit, the price, the close), and once the seller countersigns, record them from the executed copy with prepare_contract_amendment, or the contract and escrow's statement check keep the old terms. Tell the buyer that when you draft it. Restate the clauses to the buyer and call this only after they confirm the wording here. Wording that claims broker, agent, or attorney status, names Gmail, Outlook, or legal advice, promises an outcome, or speaks as the buyer is refused (a buyer's agent may be named only to say there is none). It writes the unsigned draft Ohvii's signing room opens through the returned ceremonyUrl (also get_signing_ceremony_handoff with the draftId); it signs nothing, sends nothing, records no seller agreement, and moves no deadline. Reuse mutationId only for an exact retry; a new mutationId replaces the unsigned draft. Only available while the transaction is in contract.

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.

FieldRequiredMeaning and constraints
clausesarray<string>Yes

Minimum items: 1.

Maximum items: 20.

clauses: nested contract
Array item contract

Minimum characters: 1. Maximum characters: 600.

contingencyExtensionobjectNo

Extra fields are not allowed.

contingencyExtension: nested contract
FieldRequiredMeaning and constraints
contingencyIdstringYes

Allowed: "inspection", "appraisal", "loan", "hoa", "sale-of-home".

proposedDeadlinestringYes

Format: date-time.

Pattern validation applies; see the raw schema.

sourceTextstringNo

Minimum characters: 1.

Maximum characters: 500.

contingencyExtensionsarray<object>No

Minimum items: 1.

Maximum items: 5.

contingencyExtensions: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
contingencyIdstringYes

Allowed: "inspection", "appraisal", "loan", "hoa", "sale-of-home".

proposedDeadlinestringYes

Format: date-time.

Pattern validation applies; see the raw schema.

sourceTextstringNo

Minimum characters: 1.

Maximum characters: 500.

mutationIdstringYes

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.

summarystringYes

Minimum characters: 1.

Maximum characters: 300.

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
ceremonyUrlstringYes

Format: uri.

documentobjectYes

Extra fields are not allowed.

document: nested contract
FieldRequiredMeaning and constraints
clausesarray<string>Yes

Maximum items: 20.

clauses: nested contract
Array item contract

Maximum characters: 600.

contingencyExtensionobject | nullYes

Must match at least one alternative.

contingencyExtension: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
contingencyIdstringYes

Allowed: "inspection", "appraisal", "loan", "hoa", "sale-of-home".

currentDeadlineUtcstring | nullYes

Must match at least one alternative.

currentDeadlineUtc: nested contract
Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

proposedDeadlineUtcstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

Alternative 2: null

contingencyExtensionsarray<object>Yes

Maximum items: 5.

contingencyExtensions: nested contract
Array item contract

Extra fields are not allowed.

FieldRequiredMeaning and constraints
contingencyIdstringYes

Allowed: "inspection", "appraisal", "loan", "hoa", "sale-of-home".

currentDeadlineUtcstring | nullYes

Must match at least one alternative.

currentDeadlineUtc: nested contract
Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

proposedDeadlineUtcstringYes

Format: date-time.

Pattern validation applies; see the raw schema.

draftIdstringYes

Format: uuid.

Pattern validation applies; see the raw schema.

kindstringYes

Must be "addendum".

statusstringYes

Allowed: "draft", "signed", "superseded".

summarystringYes

Maximum characters: 300.

termsToRecordarray<string>Yes

Maximum items: 11.

termsToRecord: nested contract
Array item contract

Allowed: "closeOfEscrow", "costs", "credits", "deposit", "excludedItems", "financingType", "includedItems", "purchasePrice", "rentBack", "repairs", "settlement".

mutationIdstringYes

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.

replayedbooleanYesNo additional description in the contract.
schemaVersionstringYes

Must be "1".

workspaceIdstringYes

Pattern validation applies; see the raw schema.

Raw input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "clauses": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 600
      }
    },
    "contingencyExtension": {
      "type": "object",
      "properties": {
        "contingencyId": {
          "type": "string",
          "enum": [
            "inspection",
            "appraisal",
            "loan",
            "hoa",
            "sale-of-home"
          ]
        },
        "proposedDeadline": {
          "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)))$"
        },
        "sourceText": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        }
      },
      "required": [
        "contingencyId",
        "proposedDeadline"
      ],
      "additionalProperties": false
    },
    "contingencyExtensions": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contingencyId": {
            "type": "string",
            "enum": [
              "inspection",
              "appraisal",
              "loan",
              "hoa",
              "sale-of-home"
            ]
          },
          "proposedDeadline": {
            "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)))$"
          },
          "sourceText": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          }
        },
        "required": [
          "contingencyId",
          "proposedDeadline"
        ],
        "additionalProperties": false
      }
    },
    "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."
    },
    "summary": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "clauses",
    "mutationId",
    "summary",
    "workspaceId"
  ],
  "additionalProperties": false
}
Full output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ceremonyUrl": {
      "type": "string",
      "format": "uri"
    },
    "document": {
      "type": "object",
      "properties": {
        "clauses": {
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 600
          }
        },
        "contingencyExtension": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "contingencyId": {
                  "type": "string",
                  "enum": [
                    "inspection",
                    "appraisal",
                    "loan",
                    "hoa",
                    "sale-of-home"
                  ]
                },
                "currentDeadlineUtc": {
                  "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"
                    }
                  ]
                },
                "proposedDeadlineUtc": {
                  "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)))$"
                }
              },
              "required": [
                "contingencyId",
                "currentDeadlineUtc",
                "proposedDeadlineUtc"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "contingencyExtensions": {
          "maxItems": 5,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "contingencyId": {
                "type": "string",
                "enum": [
                  "inspection",
                  "appraisal",
                  "loan",
                  "hoa",
                  "sale-of-home"
                ]
              },
              "currentDeadlineUtc": {
                "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"
                  }
                ]
              },
              "proposedDeadlineUtc": {
                "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)))$"
              }
            },
            "required": [
              "contingencyId",
              "currentDeadlineUtc",
              "proposedDeadlineUtc"
            ],
            "additionalProperties": false
          }
        },
        "draftId": {
          "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)$"
        },
        "kind": {
          "type": "string",
          "const": "addendum"
        },
        "status": {
          "type": "string",
          "enum": [
            "draft",
            "signed",
            "superseded"
          ]
        },
        "summary": {
          "type": "string",
          "maxLength": 300
        },
        "termsToRecord": {
          "maxItems": 11,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "closeOfEscrow",
              "costs",
              "credits",
              "deposit",
              "excludedItems",
              "financingType",
              "includedItems",
              "purchasePrice",
              "rentBack",
              "repairs",
              "settlement"
            ]
          }
        }
      },
      "required": [
        "clauses",
        "contingencyExtension",
        "contingencyExtensions",
        "draftId",
        "kind",
        "status",
        "summary",
        "termsToRecord"
      ],
      "additionalProperties": false
    },
    "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": [
    "ceremonyUrl",
    "document",
    "mutationId",
    "replayed",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false
}

Reference 00e5441a095c7e20. Download the full catalog.