deleteWidget
Permanently removes a widget from the system by its ID. Use only after checking that no pages rely on its shortcode to avoid broken content.
Instructions
Delete a widget - Permanently delete a widget by widget_id. Destructive - cannot be undone via API.
Use when: removing an unused widget. For "disable without deleting" use updateWidget with widget_viewport=admin (hides from public pages) - preserves the source for later use.
Destructive caveat: any page or email using [widget=Name] shortcode referencing the deleted widget will render as empty or broken at that spot. Audit with listWidgets + check page content for shortcodes referencing this widget's widget_name or short_code before deleting.
Required: widget_id.
See also: updateWidget with widget_viewport=admin (reversible hide).
Returns: { status: "success", message: "data_widgets record was deleted" }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| widget_id | Yes |