update_alternate_name
Correct, retype, or remove a person's alternate name in place while preserving citations; identify it via get_person.
Instructions
Correct, retype or remove one alternate name, in place.
Edited in place, the name keeps its citations. The primary name is update_person(name=...); a new name is add_alternate_name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| given | No | New given name(s). Omit to keep. | |
| match | Yes | Which alternate name, e.g. {'surname': 'Calloway', 'type': 'Also Known As'}. get_person lists them with their index. | |
| person | Yes | Person handle or gramps_id. | |
| remove | No | Remove the name. Refused while it carries citations or notes; of identical duplicates, one is removed. | |
| surname | No | New surname. Omit to keep. | |
| nickname | No | New nickname. | |
| name_type | No | New type, e.g. 'Married Name' for a name filed as 'Also Known As'. | |
| name_prefix | No | New surname prefix. | |
| name_suffix | No | New suffix. | |
| allow_new_type | No | Accept a type that is neither a Gramps standard type nor one of the tree's custom types, creating it as a new custom type. Only when meant: a near-miss is refused with the closest names. |