update_transaction_private_note

Update private note

Update the buyer's private note on this home (up to 5,000 characters total); nothing is sent. For new observations during a visit or afterward, use mode append with only the new text: it atomically preserves prior and concurrent notes and deduplicates exact retries. Read the current note for context, but do not copy it into an append request. Use mode replace only for a requested rewrite or empty-body clear (the legacy default). A full note rejects an append without truncating earlier entries. Reuse mutationId only for the exact same addition. Notes do not require visit completion and never complete a legal disclosure.

Effect: Draft or workspace edit
Required scopes: workspace:write
Workflow stages: closing, transaction
Data classes: transaction
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
`body`string	Yes	Maximum characters: 5000.
`mode`string	No	Allowed: "replace", "append".
`mutationId`string	Yes	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.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field Required Meaning and constraints

mutationIdstring

Yes

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.

privateNoteobject

Yes

Extra fields are not allowed.

privateNote: nested contract

Field	Required	Meaning and constraints
`body`string	Yes	Maximum characters: 5000.
`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

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": {
    "body": {
      "type": "string",
      "maxLength": 5000
    },
    "mode": {
      "type": "string",
      "enum": [
        "replace",
        "append"
      ]
    },
    "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."
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "body",
    "mutationId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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."
    },
    "privateNote": {
      "type": "object",
      "properties": {
        "body": {
          "type": "string",
          "maxLength": 5000
        },
        "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"
            }
          ]
        }
      },
      "required": [
        "body",
        "updatedAt"
      ],
      "additionalProperties": false
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "mutationId",
    "privateNote",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.