create_heir
Add a new heir to the estate. Use when the user wants to record a person who may inherit (spouse, child, stepchild, grandchild, parent, sibling, or other relative). Call once the customer has confirmed how the person is related to the DECEASED — any wording is accepted. "My brother Tom" is the customer's brother, not the deceased's: ask (e.g. "Is Tom your mom's son?") before saving.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The heir's name exactly as the customer gave it. Never add a last name or any part they didn't give — ask for the full name if a form needs it. | |
| No | Email address | ||
| notes | No | Free-text notes about this heir — context like whereabouts unknown, predeceased details, per-stirpes notes, disputes, or anything the user wants remembered. Multi-line OK. | |
| phone | No | Phone number (any format) | |
| address | No | Mailing address (free text, multi-line OK). Used for formal probate notice. | |
| is_minor | No | Whether the heir is under 18. Required for every living heir except a spouse or parent — if the user hasn't said, ask them; never assume an adult. | |
| 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 (default false). Used for per stirpes inheritance. | |
| is_divorced | No | For a spouse only: whether they are a divorced/former spouse (default false). A divorced spouse is recorded for a complete family picture but is not a surviving spouse and does not inherit under intestacy. | |
| relationship | Yes | Relationship to the deceased. Canonical values: spouse, child, stepchild, grandchild, parent, sibling, other. If the user's wording doesn't match one (e.g. 'half-brother', 'daughter-in-law', 'adult stepchild'), pass their wording as-is — it is normalized automatically. Never re-ask the user for a 'valid' relationship. | |
| parent_heir_id | No | ID of the parent heir if this person inherits through a deceased parent (e.g. grandchild whose parent predeceased the decedent). Omit otherwise. | |
| name_from_document | No | true when the 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 (e.g. 'stepson', 'half-sister', 'goddaughter'). Shown on probate forms, so preserve the user's words. | |
| relationship_confirmed | No | 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. |