update_heir
Update an existing heir's details. Use when the user wants to correct or add information to a recorded heir. Get the heir_id from the pre-loaded Heirs context block.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Updated name exactly as the customer gave it. Never add a last name or any part they didn't give. | |
| No | Updated email address (empty string clears it) | ||
| notes | No | Updated free-text notes about this heir (empty string clears). Use for context like whereabouts unknown, predeceased details, per-stirpes notes, disputes, or anything the user wants remembered. | |
| phone | No | Updated phone number (empty string clears it) | |
| address | No | Updated mailing address (empty string clears it) | |
| heir_id | Yes | ID of the heir to update | |
| is_minor | No | Whether the heir is under 18 | |
| estate_id | Yes | The estate to act on. Call list_my_estates first to get this id. | |
| is_deceased | No | Whether the heir is deceased | |
| is_divorced | No | For a spouse only: whether they are a divorced/former spouse (not a surviving spouse). | |
| relationship | No | Updated relationship to the deceased. Canonical values: spouse, child, stepchild, grandchild, parent, sibling, other. Free-text wording (e.g. 'half-brother') is accepted and normalized automatically. "My brother" is the customer's brother, not the deceased's: ask before changing it. | |
| parent_heir_id | No | ID of the heir this person inherits through (e.g. a grandchild's predeceased parent). Use it to fix or add that link; empty string removes it. | |
| name_from_document | No | true when the new name was read from a document the customer shared rather than typed by them. | |
| relationship_detail | No | The relationship exactly as the user described it, when it carries more than the canonical value (empty string clears it). Shown on probate forms. | |
| relationship_confirmed | No | Required when changing relationship: true only when the customer has said or confirmed this person's relationship to the deceased (not to themselves), in this conversation or in a document they shared. |