Delete Object
delete_objectDeletes a specified Gramps Web record after confirmation; if other records link to it, deletion is blocked and backlinks are returned so you can unlink them first or force deletion.
Instructions
Delete one record; undo_change with the deletion's transaction from get_recent_changes restores it. Call it only after the user confirmed this exact record. If other records still point to it, nothing is deleted and the reply lists those backlinks by type; unlink them first with the owners' update tools, or pass force=true after a separate confirmation. Clients that support it also show the user a confirmation dialog before deleting; action: declined or cancelled means the user said no and nothing was deleted. On success returns the type, action: deleted and the handle; a missing record returns a not-found message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | true deletes even when other records still point to it, leaving those links dangling (default false). | |
| handle | Yes | The record to delete. Handle or Gramps ID (e.g. I0001), resolved automatically; find it with search or list_objects. | |
| objectType | Yes | Record type: person, family, event, place, source, citation, note, media, repository or tag. |