Delete elements
delete_elementsDelete any elements from an Archicad project by GUID in one undo step. Removes dependent items like doors, dimensions, and sub-elements automatically and reports everything deleted.
Instructions
Deletes elements of ANY type (one undo step: undo restores them). Dependent elements are removed by Archicad too and are reported: windows/doors of deleted walls, associative dimensions and labels, etc. -> alsoDeleted: [{guid, type}], subElementsDeleted (curtain wall / stair / railing parts). Only delete elements you created or were asked to delete. Group GUIDs delete the whole group. Returns {results: [{guid, deleted: true} | {guid, error}], deletedCount, alsoDeleted?, subElementsDeleted?, warnings?}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| elements | Yes | Elements to edit: GUID strings (or {guid}) of any element type, e.g. from get_element_details / element search tools. A group GUID stands for all elements of that group. | |
| includeGroupMembers | No | Default false: ONLY the listed elements are affected even when they belong to groups (Suspend Groups is switched on for the duration of the call and restored afterwards). true: all members of their (top-level) groups are affected as well. |