Skip to content
Settings and rules

Update a product rule

Changes a product rule: send only the fields to change (name, conditions, action, enabled, priority).

PUT /properties/{propertyId}/product-rules/{ruleId}

Scope write · Access Changes data · Operation id product_rules.update

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID, $RULE_ID first.

productmetrics product-rules update \
  --property-id $PROPERTY_ID \
  --rule-id $RULE_ID \
  --json

Response

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_01JT54G3F0WY6W72GKXPTNYA9X"
}

CLI output: productmetrics product-rules update --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Check new conditions with product_rules.preview first. The change reaches the feed at the nightly run, or now with feed.generate. Needs an editor or admin.

Path parameters

NameTypeDescription
propertyIdstring (uuid)A property_id from properties.list.
ruleIdstring (uuid)The id of a rule from product_rules.list.

Query parameters

NameTypeRequiredDescription
feed_scopestringNoWhich feed of the property: a feed id, or all for the property-wide settings. Omitted: the property’s default scope.

Body

NameTypeRequiredDescription
namestringNoThe rule’s name, shown in the product rules list.
descriptionstring or nullNoAn optional note on what the rule is for.
enabledbooleanNoChanges a product rule: send only the fields to change (name, conditions, action, enabled, priority).
when_colsarray of stringNoThe product column each condition reads (for example custom_label_0 or brand), one per condition. At least 1 item.
when_opsarray of enumNoThe operator of each condition, in the order of when_cols. Each one of ==, !=, <, <=, >, >=, contains, not_contains, in, not_in, regex, is_empty, is_not_empty.
when_valsarray of stringNoThe value each condition compares with, in the order of when_cols.
when_logicarray of enum or nullNoHow each condition joins the next (AND or OR), in the order of when_cols. Each one of AND, OR.
when_treeobjectNoThe conditions as a tree: match all or any of items, which can hold nested groups.
when_tree.matchenumYesall: every item must match; any: one is enough. One of all, any.
when_tree.itemsarray of objectYesThe conditions and nested groups at this level. At least 1 item.
when_tree.items[].columnstringNoThe product column the condition reads.
when_tree.items[].operatorenumNoHow the column is compared with value. One of ==, !=, <, <=, >, >=, contains, not_contains, in, not_in, regex, is_empty, is_not_empty.
when_tree.items[].valuestringNoThe value the column is compared with.
when_tree.items[].matchenumNoIn a nested group: all or any of its items. One of all, any.
when_tree.items[].itemsarray of objectNoIn a nested group: its conditions. At least 1 item.
target_colsarray of enumNoThe feed columns the rule writes: the product segment label, the category priority label, or both. Each one of product_segment, category_priority. At least 1 item.
actionenumNo= writes action_value; keep locks the products’ current segment until active_until. One of =, keep.
action_valuestringNoThe value written to target_cols with action =, for example the segment stars.
active_untilstring (date-time) or nullNoWith action keep: when the lock ends (ISO 8601).
priorityintegerNoChanges a product rule: send only the fields to change (name, conditions, action, enabled, priority).

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_01J5D4M3ES63E1W7QZ97Z1J09X"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the write scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Settings and rules operations