← Tool reference

update_buyer_profile

Update buyer profile

Update buyer profile fields from the current agent conversation using the exact profile revision. Omitted fields are preserved; null clears an optional entity or co-buyer. The account email always comes from OAuth and cannot be changed by this tool.

Effect
Draft or workspace edit
Required scopes
workspace:write
Workflow stages
offer, transaction
Data classes
account profile, 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.

FieldRequiredMeaning and constraints
expectedRevisionstringYes

Must match at least one alternative.

expectedRevision: nested contract
Alternative 1: string

Must be "missing".

Alternative 2: string

Pattern validation applies; see the raw schema.

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.

patchobjectYes

Extra fields are not allowed.

patch: nested contract
FieldRequiredMeaning and constraints
legalNamestringNo

Minimum characters: 1.

Maximum characters: 120.

phonestringNo

Maximum characters: 40.

Pattern validation applies; see the raw schema.

entityobject | nullNo

Must match at least one alternative.

entity: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
entityNamestringYes

Minimum characters: 1.

Maximum characters: 200.

entityTypestringYes

Allowed: "llc", "corporation", "trust", "partnership".

entityStatestringYes

Minimum characters: 1.

Maximum characters: 120.

signatoryNamestringYes

Minimum characters: 1.

Maximum characters: 200.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

Alternative 2: null

coBuyerobject | nullNo

Must match at least one alternative.

coBuyer: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
namestringYes

Minimum characters: 1.

Maximum characters: 200.

emailstringYes

Minimum characters: 1.

Maximum characters: 254.

Pattern validation applies; see the raw schema.

entityobject | nullNo

Must match at least one alternative.

entity: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
entityNamestringYes

Minimum characters: 1.

Maximum characters: 200.

entityTypestringYes

Allowed: "llc", "corporation", "trust", "partnership".

entityStatestringYes

Minimum characters: 1.

Maximum characters: 120.

signatoryNamestringYes

Minimum characters: 1.

Maximum characters: 200.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

Alternative 2: null

Alternative 2: null

timezonestringNo

Maximum characters: 64.

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
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.

profileobjectYes

Extra fields are not allowed.

profile: nested contract
FieldRequiredMeaning and constraints
coBuyerobject | nullYes

Must match at least one alternative.

coBuyer: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
emailstringYes

Format: email.

Pattern validation applies; see the raw schema.

entityobjectNo

Extra fields are not allowed.

entity: nested contract
FieldRequiredMeaning and constraints
entityNamestringYes

Minimum characters: 1.

Maximum characters: 200.

entityTypestringYes

Allowed: "llc", "corporation", "trust", "partnership".

entityStatestringNo

Minimum characters: 1.

Maximum characters: 120.

signatoryNamestringNo

Minimum characters: 1.

Maximum characters: 200.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

namestringYes

Minimum characters: 1.

Maximum characters: 200.

Alternative 2: null

emailstring | nullYes

Must match at least one alternative.

email: nested contract
Alternative 1: string

Format: email. Pattern validation applies; see the raw schema.

Alternative 2: null

entityobject | nullYes

Must match at least one alternative.

entity: nested contract
Alternative 1: object

Extra fields are not allowed.

FieldRequiredMeaning and constraints
entityNamestringYes

Minimum characters: 1.

Maximum characters: 200.

entityTypestringYes

Allowed: "llc", "corporation", "trust", "partnership".

entityStatestringNo

Minimum characters: 1.

Maximum characters: 120.

signatoryNamestringNo

Minimum characters: 1.

Maximum characters: 200.

titlestringYes

Minimum characters: 1.

Maximum characters: 120.

Alternative 2: null

legalNamestring | nullYes

Must match at least one alternative.

legalName: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 120.

Alternative 2: null

missingFieldsarray<string>YesNo additional description in the contract.
missingFields: nested contract
Array item contract

Allowed: "email", "legal_name", "phone", "timezone".

phonestring | nullYes

Must match at least one alternative.

phone: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 40.

Alternative 2: null

revisionstringYes

Must match at least one alternative.

revision: nested contract
Alternative 1: string

Must be "missing".

Alternative 2: string

Pattern validation applies; see the raw schema.

timezonestring | nullYes

Must match at least one alternative.

timezone: nested contract
Alternative 1: string

Minimum characters: 1. Maximum characters: 64.

Alternative 2: null

schemaVersionstringYes

Must be "1".

Raw input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "anyOf": [
        {
          "type": "string",
          "const": "missing"
        },
        {
          "type": "string",
          "pattern": "^[0-9a-f]{64}$"
        }
      ]
    },
    "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."
    },
    "patch": {
      "type": "object",
      "properties": {
        "legalName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "phone": {
          "type": "string",
          "maxLength": 40,
          "pattern": "^\\D*(?:\\d\\D*){10}$"
        },
        "entity": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "entityName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "entityType": {
                  "type": "string",
                  "enum": [
                    "llc",
                    "corporation",
                    "trust",
                    "partnership"
                  ]
                },
                "entityState": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                },
                "signatoryName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "title": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                }
              },
              "required": [
                "entityName",
                "entityType",
                "entityState",
                "signatoryName",
                "title"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "coBuyer": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "email": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 254,
                  "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
                },
                "entity": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "entityName": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        },
                        "entityType": {
                          "type": "string",
                          "enum": [
                            "llc",
                            "corporation",
                            "trust",
                            "partnership"
                          ]
                        },
                        "entityState": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 120
                        },
                        "signatoryName": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        },
                        "title": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 120
                        }
                      },
                      "required": [
                        "entityName",
                        "entityType",
                        "entityState",
                        "signatoryName",
                        "title"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "name",
                "email"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "timezone": {
          "type": "string",
          "maxLength": 64
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "expectedRevision",
    "mutationId",
    "patch"
  ],
  "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."
    },
    "profile": {
      "type": "object",
      "properties": {
        "coBuyer": {
          "anyOf": [
            {
              "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,}$"
                },
                "entity": {
                  "type": "object",
                  "properties": {
                    "entityName": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "entityType": {
                      "type": "string",
                      "enum": [
                        "llc",
                        "corporation",
                        "trust",
                        "partnership"
                      ]
                    },
                    "entityState": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    },
                    "signatoryName": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "title": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 120
                    }
                  },
                  "required": [
                    "entityName",
                    "entityType",
                    "title"
                  ],
                  "additionalProperties": false
                },
                "name": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                }
              },
              "required": [
                "email",
                "name"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "email": {
          "anyOf": [
            {
              "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,}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "entity": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "entityName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "entityType": {
                  "type": "string",
                  "enum": [
                    "llc",
                    "corporation",
                    "trust",
                    "partnership"
                  ]
                },
                "entityState": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                },
                "signatoryName": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                },
                "title": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 120
                }
              },
              "required": [
                "entityName",
                "entityType",
                "title"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "legalName": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            {
              "type": "null"
            }
          ]
        },
        "missingFields": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "email",
              "legal_name",
              "phone",
              "timezone"
            ]
          }
        },
        "phone": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            {
              "type": "null"
            }
          ]
        },
        "revision": {
          "anyOf": [
            {
              "type": "string",
              "const": "missing"
            },
            {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            }
          ]
        },
        "timezone": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "coBuyer",
        "email",
        "entity",
        "legalName",
        "missingFields",
        "phone",
        "revision",
        "timezone"
      ],
      "additionalProperties": false
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    }
  },
  "required": [
    "mutationId",
    "profile",
    "schemaVersion"
  ],
  "additionalProperties": false
}
Tool annotations
{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": false
}

Reference 00e5441a095c7e20. Download the full catalog.