prepare_offer_terms_confirmation
Prepare offer terms review
Prepare one exact set of offer-draft terms for the buyer to review. Returns the exact terms, a terms hash, and an expiry. Show these terms to the buyer in this conversation and ask them there; a reviewUrl is also returned for a buyer who would rather read them on Ohvii. This changes no offer state, creates no document, and is not a signature, a submission, or a legal acceptance.
- Effect
- Read
- Required scopes
offers:confirm- Workflow stages
- offer, transaction
- Data classes
- offer
- 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 |
|---|---|---|
expectedRevisioninteger | Yes | Maximum: 9007199254740991. Greater than: 0. |
idempotencyKeystring | 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. |
workspaceIdstring | Yes | Format: uuid. 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.
| Field | Required | Meaning and constraints | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
preparedActionobject | Yes | Extra fields are not allowed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preparedAction: nested contract
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schemaVersionstring | Yes | Must be "1". | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"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",
"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)$"
}
},
"required": [
"expectedRevision",
"idempotencyKey",
"workspaceId"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"preparedAction": {
"type": "object",
"properties": {
"action": {
"type": "string",
"const": "confirm_offer_draft_terms"
},
"buyerDecision": {
"anyOf": [
{
"type": "string",
"enum": [
"approved",
"declined"
]
},
{
"type": "null"
}
]
},
"expectedRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"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)))$"
},
"reviewUrl": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"summary": {
"type": "object",
"properties": {
"buyer": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"legalName": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"email",
"legalName",
"phone",
"timezone"
],
"additionalProperties": false
},
"offerTerms": {
"type": "object",
"properties": {
"additionalTerms": {
"type": "string",
"maxLength": 10000
},
"contingencies": {
"type": "object",
"properties": {
"appraisal": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
},
"appraisalGapAmount": {
"type": "number",
"minimum": 0,
"maximum": 100000000
}
},
"required": [
"days",
"enabled",
"appraisalGapAmount"
],
"additionalProperties": false
},
"financing": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
}
},
"required": [
"days",
"enabled"
],
"additionalProperties": false
},
"hoa": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
}
},
"required": [
"days",
"enabled"
],
"additionalProperties": false
},
"inspection": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
}
},
"required": [
"days",
"enabled"
],
"additionalProperties": false
},
"other": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 10000
}
},
"required": [
"days",
"enabled",
"description"
],
"additionalProperties": false
},
"saleOfHome": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"enabled": {
"type": "boolean"
},
"address": {
"type": "string",
"maxLength": 500
}
},
"required": [
"days",
"enabled",
"address"
],
"additionalProperties": false
}
},
"required": [
"appraisal",
"financing",
"hoa",
"inspection",
"other",
"saleOfHome"
],
"additionalProperties": false
},
"dateTerms": {
"type": "object",
"properties": {
"closeOfEscrow": {
"oneOf": [
{
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "acceptance"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"mode": {
"type": "string",
"const": "relative"
},
"roll": {
"type": "string",
"const": "next_permitted_day"
}
},
"required": [
"anchor",
"basis",
"days",
"mode",
"roll"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"date": {
"type": "string",
"maxLength": 10
},
"mode": {
"type": "string",
"const": "exact_date"
},
"roll": {
"type": "string",
"const": "next_permitted_day"
}
},
"required": [
"date",
"mode",
"roll"
],
"additionalProperties": false
}
]
},
"disclosureDelivery": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "acceptance"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"roll": {
"type": "string",
"const": "next_permitted_day"
}
},
"required": [
"anchor",
"basis",
"days",
"roll"
],
"additionalProperties": false
},
"disclosureReview": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "delivery"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
}
},
"required": [
"anchor",
"basis",
"days"
],
"additionalProperties": false
},
"finalVerification": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "close_of_escrow"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"direction": {
"type": "string",
"const": "before"
}
},
"required": [
"anchor",
"basis",
"days",
"direction"
],
"additionalProperties": false
},
"initialDeposit": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "acceptance"
},
"basis": {
"type": "string",
"const": "business_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
}
},
"required": [
"anchor",
"basis",
"days"
],
"additionalProperties": false
},
"offerExpiration": {
"oneOf": [
{
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "all_buyer_signatures"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"mode": {
"type": "string",
"const": "relative"
},
"timeLocal": {
"type": "string",
"maxLength": 5
}
},
"required": [
"anchor",
"basis",
"days",
"mode",
"timeLocal"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"date": {
"type": "string",
"maxLength": 10
},
"mode": {
"type": "string",
"const": "exact_date_time"
},
"timeLocal": {
"type": "string",
"maxLength": 5
}
},
"required": [
"date",
"mode",
"timeLocal"
],
"additionalProperties": false
}
]
},
"titleDelivery": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "acceptance"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"roll": {
"type": "string",
"const": "next_permitted_day"
}
},
"required": [
"anchor",
"basis",
"days",
"roll"
],
"additionalProperties": false
},
"titleReview": {
"type": "object",
"properties": {
"anchor": {
"type": "string",
"const": "delivery"
},
"basis": {
"type": "string",
"const": "calendar_days"
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
}
},
"required": [
"anchor",
"basis",
"days"
],
"additionalProperties": false
}
},
"required": [
"closeOfEscrow",
"disclosureDelivery",
"disclosureReview",
"finalVerification",
"initialDeposit",
"offerExpiration",
"titleDelivery",
"titleReview"
],
"additionalProperties": false
},
"downPaymentAmount": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"downPaymentPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
},
"earnestMoneyAmount": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"excludedItems": {
"type": "string",
"maxLength": 10000
},
"financingReadiness": {
"anyOf": [
{
"type": "string",
"enum": [
"preapproved",
"in_progress",
"needs_preapproval",
"not_applicable"
]
},
{
"type": "null"
}
]
},
"includedItems": {
"type": "string",
"maxLength": 10000
},
"possession": {
"type": "object",
"properties": {
"details": {
"type": "string",
"maxLength": 10000
},
"mode": {
"type": "string",
"enum": [
"at_close",
"different"
]
}
},
"required": [
"details",
"mode"
],
"additionalProperties": false
},
"purchasePrice": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"repairTerms": {
"type": "string",
"maxLength": 10000
},
"schemaVersion": {
"type": "number",
"const": 3
},
"sellerCredits": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"description": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"amount",
"description"
],
"additionalProperties": false
}
},
"sellerRentBack": {
"type": "object",
"properties": {
"dailyRate": {
"type": "number",
"minimum": 0,
"maximum": 1000000
},
"days": {
"type": "integer",
"minimum": 0,
"maximum": 365
},
"details": {
"type": "string",
"maxLength": 10000
},
"enabled": {
"type": "boolean"
}
},
"required": [
"dailyRate",
"days",
"details",
"enabled"
],
"additionalProperties": false
},
"settlement": {
"type": "object",
"properties": {
"escrowHolder": {
"type": "string",
"maxLength": 2000
},
"titleCompany": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"escrowHolder",
"titleCompany"
],
"additionalProperties": false
},
"contingenciesWaived": {
"type": "boolean"
},
"dateTermsReviewed": {
"type": "boolean"
},
"costs": {
"anyOf": [
{
"type": "object",
"properties": {
"escrow": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
},
"hoaAndNhd": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
},
"homeWarranty": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
"maximum": 100000
},
"payer": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
},
"requested": {
"type": "boolean"
}
},
"required": [
"amount",
"payer",
"requested"
],
"additionalProperties": false
},
"recording": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
},
"titlePolicy": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
},
"transferTaxes": {
"type": "string",
"enum": [
"buyer",
"seller",
"split"
]
}
},
"required": [
"escrow",
"hoaAndNhd",
"homeWarranty",
"recording",
"titlePolicy",
"transferTaxes"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"financingType": {
"anyOf": [
{
"type": "string",
"enum": [
"conventional",
"cash",
"fha",
"va",
"other"
]
},
{
"type": "null"
}
]
}
},
"required": [
"additionalTerms",
"contingencies",
"dateTerms",
"downPaymentAmount",
"downPaymentPercent",
"earnestMoneyAmount",
"excludedItems",
"financingReadiness",
"includedItems",
"possession",
"purchasePrice",
"repairTerms",
"schemaVersion",
"sellerCredits",
"sellerRentBack",
"settlement",
"costs",
"financingType"
],
"additionalProperties": false
},
"propertyAddress": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"termsHash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"warnings": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"enum": [
"internal_terms_review_only",
"not_a_signature",
"not_a_submission",
"not_legal_acceptance",
"no_documents_generated"
]
}
}
},
"required": [
"buyer",
"offerTerms",
"propertyAddress",
"termsHash",
"warnings"
],
"additionalProperties": false
},
"workspaceId": {
"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)$"
}
},
"required": [
"action",
"buyerDecision",
"expectedRevision",
"expiresAt",
"preparedActionId",
"preparedAt",
"reviewUrl",
"summary",
"workspaceId"
],
"additionalProperties": false
},
"schemaVersion": {
"type": "string",
"const": "1"
}
},
"required": [
"preparedAction",
"schemaVersion"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}Reference 00e5441a095c7e20. Download the full catalog.