update_offer_package
Update offer package
Update the offer-package form, preparation checks, and selected buyer-owned attachments at the exact package revision, before the offer is signed; a signed offer's packet is sealed, and further files go on its delivery email (create_offer_delivery_draft). Seller identity fields may remain blank and do not block offer preparation or signing; the agreement uses Seller(s) of Record. When disclosures or title documents clearly identify this property's seller, fill only empty seller fields from those original pages, preserve buyer-entered values, and do not infer signatory authority. It takes at most 10 attachments. This can invalidate an older review or signing preparation. It does not generate, confirm, sign, or send an offer.
- Effect
- Draft or workspace edit
- Required scopes
workspace:write- Workflow stages
- offer, transaction
- Data classes
- offer
- 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
attachmentDocumentIdsarray<string> | Yes | Maximum items: 10. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attachmentDocumentIds: nested contractArray item contractMinimum characters: 1. Maximum characters: 200. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expectedRevisioninteger | Yes | Minimum: 0. Maximum: 9007199254740991. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
formobject | Yes | Extra fields are not allowed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form: nested contract
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
preparationChecksobject | Yes | No additional description in the contract. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offerPackageobject | Yes | Extra fields are not allowed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offerPackage: nested contract
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageStatestring | No | Allowed: "editable", "sealed". | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schemaVersionstring | Yes | Must be "1". | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attachmentDocumentIds": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"form": {
"type": "object",
"properties": {
"buyerContact": {
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254
},
"name": {
"type": "string",
"maxLength": 200
},
"phone": {
"type": "string",
"maxLength": 40
}
},
"required": [
"email",
"name",
"phone"
],
"additionalProperties": false
},
"buyerEntity": {
"anyOf": [
{
"type": "object",
"properties": {
"entityName": {
"type": "string",
"maxLength": 200
},
"entityState": {
"type": "string",
"maxLength": 100
},
"entityType": {
"type": "string",
"enum": [
"llc",
"corporation",
"trust",
"partnership"
]
},
"signatoryName": {
"type": "string",
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 200
}
},
"required": [
"entityName",
"entityType",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"coBuyerContact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254
},
"name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"coBuyerEnabled": {
"type": "boolean"
},
"coBuyerEntity": {
"anyOf": [
{
"type": "object",
"properties": {
"entityName": {
"type": "string",
"maxLength": 200
},
"entityState": {
"type": "string",
"maxLength": 100
},
"entityType": {
"type": "string",
"enum": [
"llc",
"corporation",
"trust",
"partnership"
]
},
"signatoryName": {
"type": "string",
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 200
}
},
"required": [
"entityName",
"entityType",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"documentDetails": {
"type": "object",
"properties": {
"legalDescription": {
"type": "string",
"maxLength": 10000
},
"sellerAuthorizedSignatory": {
"type": "string",
"maxLength": 200
},
"sellerEntityName": {
"type": "string",
"maxLength": 200
},
"sellerEntityTitle": {
"type": "string",
"maxLength": 200
},
"sellerName": {
"type": "string",
"maxLength": 500
}
},
"required": [
"legalDescription",
"sellerAuthorizedSignatory",
"sellerEntityName",
"sellerEntityTitle",
"sellerName"
],
"additionalProperties": false
}
},
"required": [
"buyerContact",
"buyerEntity",
"coBuyerContact",
"coBuyerEnabled",
"coBuyerEntity",
"documentDetails"
],
"additionalProperties": false
},
"preparationChecks": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,80}$"
},
"additionalProperties": {
"type": "boolean"
}
},
"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": [
"attachmentDocumentIds",
"expectedRevision",
"form",
"preparationChecks",
"workspaceId"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offerPackage": {
"type": "object",
"properties": {
"availableAttachments": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"contentType": {
"type": "string",
"maxLength": 200
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"filename": {
"type": "string",
"maxLength": 500
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"contentType",
"documentId",
"filename",
"size"
],
"additionalProperties": false
}
},
"form": {
"type": "object",
"properties": {
"buyerContact": {
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254
},
"name": {
"type": "string",
"maxLength": 200
},
"phone": {
"type": "string",
"maxLength": 40
}
},
"required": [
"email",
"name",
"phone"
],
"additionalProperties": false
},
"buyerEntity": {
"anyOf": [
{
"type": "object",
"properties": {
"entityName": {
"type": "string",
"maxLength": 200
},
"entityState": {
"type": "string",
"maxLength": 100
},
"entityType": {
"type": "string",
"enum": [
"llc",
"corporation",
"trust",
"partnership"
]
},
"signatoryName": {
"type": "string",
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 200
}
},
"required": [
"entityName",
"entityType",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"coBuyerContact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254
},
"name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"coBuyerEnabled": {
"type": "boolean"
},
"coBuyerEntity": {
"anyOf": [
{
"type": "object",
"properties": {
"entityName": {
"type": "string",
"maxLength": 200
},
"entityState": {
"type": "string",
"maxLength": 100
},
"entityType": {
"type": "string",
"enum": [
"llc",
"corporation",
"trust",
"partnership"
]
},
"signatoryName": {
"type": "string",
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 200
}
},
"required": [
"entityName",
"entityType",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"documentDetails": {
"type": "object",
"properties": {
"legalDescription": {
"type": "string",
"maxLength": 10000
},
"sellerAuthorizedSignatory": {
"type": "string",
"maxLength": 200
},
"sellerEntityName": {
"type": "string",
"maxLength": 200
},
"sellerEntityTitle": {
"type": "string",
"maxLength": 200
},
"sellerName": {
"type": "string",
"maxLength": 500
}
},
"required": [
"legalDescription",
"sellerAuthorizedSignatory",
"sellerEntityName",
"sellerEntityTitle",
"sellerName"
],
"additionalProperties": false
}
},
"required": [
"buyerContact",
"buyerEntity",
"coBuyerContact",
"coBuyerEnabled",
"coBuyerEntity",
"documentDetails"
],
"additionalProperties": false
},
"isPersisted": {
"type": "boolean"
},
"preparationChecks": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,80}$"
},
"additionalProperties": {
"type": "boolean"
}
},
"review": {
"type": "object",
"properties": {
"invalidatedAt": {
"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"
}
]
},
"invalidationReason": {
"anyOf": [
{
"type": "string",
"enum": [
"attachments_changed",
"material_fields_changed"
]
},
{
"type": "null"
}
]
},
"reviewedAt": {
"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"
}
]
},
"state": {
"type": "string",
"enum": [
"not_reviewed",
"reviewed",
"stale"
]
}
},
"required": [
"invalidatedAt",
"invalidationReason",
"reviewedAt",
"state"
],
"additionalProperties": false
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"selectedAttachments": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"contentType": {
"type": "string",
"maxLength": 200
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"filename": {
"type": "string",
"maxLength": 500
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"contentType",
"documentId",
"filename",
"size"
],
"additionalProperties": false
}
},
"staleness": {
"type": "object",
"properties": {
"attachmentInventoryChanged": {
"type": "boolean"
},
"draftChanged": {
"type": "boolean"
},
"requiresRefresh": {
"type": "boolean"
}
},
"required": [
"attachmentInventoryChanged",
"draftChanged",
"requiresRefresh"
],
"additionalProperties": false
},
"updatedAt": {
"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)))$"
},
"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": [
"availableAttachments",
"form",
"isPersisted",
"preparationChecks",
"review",
"revision",
"selectedAttachments",
"staleness",
"updatedAt",
"workspaceId"
],
"additionalProperties": false
},
"packageState": {
"type": "string",
"enum": [
"editable",
"sealed"
]
},
"schemaVersion": {
"type": "string",
"const": "1"
}
},
"required": [
"offerPackage",
"schemaVersion"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": false,
"readOnlyHint": false
}Reference 00e5441a095c7e20. Download the full catalog.