Documentation

delete_custom_event_rule

Deletes a tracking rule. The tracker stops firing it within about 60 seconds.

Needs Growth or higher for dataChanges store configuration

When to use it

To retire a rule you no longer need. Events already recorded are kept — deleting the rule stops collection, it does not erase history.

Ask for it like this

You do not name the tool. These are questions that make an assistant reach for it:

Stop tracking the size chart event.

Parameters

ruleId
numberrequired
The rule id from list_custom_event_rules.

Shared parameters it accepts

None. This tool is not date-scoped — it reports current state rather than a window.

Every tool also accepts merchantId, which resolves from your connection. You never pass it.

What comes back

JSON. These are the top-level keys; date-scoped tools additionally carry a _meta block with the server date and the data coverage envelope.

success
false when no rule with that id belongs to this store.
description
Confirmation, including that historical events are retained.

Pairs with