Turn a product rule on or off
Switches a product rule between enabled and disabled; a disabled rule is kept but no longer applies.
PATCH /properties/{propertyId}/product-rules/{ruleId}/toggle
Scope write · Access Changes data · Operation id product_rules.toggle
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID, $RULE_ID first.
productmetrics product-rules toggle \
--property-id $PROPERTY_ID \
--rule-id $RULE_ID \
--jsonResponse
API response (200), shortened:
{
"data": {
"rule": {
"id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
"google_ads_property_feed_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"user_id": "3e9b5c71-2f4a-4d8e-b6c0-1a2b3c4d5e6f",
"name": "Lock Stars during the winter sale",
"description": "Keeps winter jackets as Stars until the sale ends."
// … 14 more fields
}
},
"request_id": "req_01J64V4BJFTEQCPZH0SZSSEDGH"
}CLI output: productmetrics product-rules toggle --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Use it to test the feed without a rule instead of deleting it. The change reaches the feed at the nightly run, or now with feed.generate. Needs an editor or admin.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | A property_id from properties.list. |
ruleId | string (uuid) | The id of a rule from product_rules.list. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
feed_scope | string | No | Which feed of the property: a feed id, or all for the property-wide settings. Omitted: the property’s default scope. |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the write scope; connect again and allow it.",
"details": {
"required_scope": "write"
}
},
"request_id": "req_01JWYV4QYAQA7NDFGZD1NSJYWM"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the write scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |