delete_object
Permanently remove a Gramps family-tree object by handle or gramps_id, cleaning up all references. Use carry_to when the object solely holds notes or images that must be preserved.
Instructions
Permanently delete an object from the tree by handle or gramps_id.
DESTRUCTIVE. The server also removes every reference to it. Refused when it is the only holder of a note or image (pass carry_to to move them), and for a source with citations, which the server would delete with it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| target | Yes | Handle or gramps_id of the object to delete. | |
| carry_to | No | Another object of the same type to receive the notes and images that only this one holds. Without it, such a delete is refused. | |
| object_type | Yes | Type to delete: 'person', 'family', 'event', 'place', 'source', 'citation', 'repository', 'media', 'note', 'tag'. |