> ## Documentation Index
> Fetch the complete documentation index at: https://e328d4e-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://e328d4e-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://e328d4e-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://e328d4e-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Save Product Segmentation settings (/docs/api/settings/update)

<!-- agent-signals: reading_time_min: 8 · est_tokens: 6996 · updated: 2026-11-16 -->
Related: [Generate the feed now](/docs/api/settings/feed-generate.md), [Get feed source settings](/docs/api/settings/feed-source-settings-get.md), [Save feed source settings](/docs/api/settings/feed-source-settings-update.md), [Get Product Segmentation settings](/docs/api/settings/get.md), [Get inventory planning settings](/docs/api/settings/inventory-settings-get.md), [Save an inventory planning setting](/docs/api/settings/inventory-settings-update.md)

> Saves the property's Product Segmentation settings.

`PUT https://prod-backend.productmetrics.io/api/public/v1/properties/{propertyId}/settings`

**Scope** `write` · **Access** Changes data · **Operation id** `settings.update`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)). Set `$PROPERTY_ID` first.



**productmetrics CLI:**

```bash
# body.json holds the JSON body from the curl example
productmetrics settings update \
  --property-id $PROPERTY_ID \
  --body-file body.json \
  --if-match '"<settings_version>"' \
  --json
```

**curl:**

```bash
curl -X PUT "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/settings" \
  -H "Authorization: Bearer $PM_TOKEN" \
  -H 'If-Match: "<settings_version>"' \
  -H "Content-Type: application/json" \
  -d '{
    "labelizer_settings": {
      "weights": {
        "w_ctr": 12.5,
        "w_cvr": 12.5,
        "w_roas": 1.5,
        "w_revenue": 108,
        "w_click_rank": 12.5,
        "w_click_boost": 12.5,
        "w_conversions": 14,
        "w_cost_penalty": 12.5,
        "w_click_potential": 12.5,
        "w_impression_boost": 12.5,
        "w_spend_share_boost": 12.5
      },
      "saved_at": "2026-11-02T09:30:00.000Z",
      "min_clicks": 120,
      "category_cols": [
        "custom_label_0"
      ],
      "saved_by_user_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
      "roas_threshold_low": 1.5,
      "min_conversions_for_growth": 12.5,
      "penalty_no_conversion_or_revenue": 108
    }
  }'
```

## Response



API response (200):

```json
{
  "data": {
    "success": true,
    "labelizer_settings": {
      "category_cols": [
        "custom_label_0"
      ],
      "category_col_source": "auto",
      "min_clicks": 120,
      "data_range": "L30D",
      "excluded_campaign_ids": [
        "21334455667"
      ],
      "supplemental_feed_source_settings": {
        "product_segment": {
          "enabled": true,
          "target_custom_label": "custom_label_0"
        },
        "category_priority": {
          "enabled": true,
          "target_custom_label": "custom_label_0"
        },
        "force_override": true,
        "custom_fields": "custom_label_0"
      },
      "auto_optimized": {
        "source": "first_labelizer_call",
        "mode": "aggressive",
        "target_stars_revenue_min": 12.5,
        "target_stars_revenue_max": 12.5,
        "target_stars_revenue_ideal": 12.5,
        "recommended_min_clicks": 120,
        "confidence": "high",
        "reason_code": "target_reached",
        "stars_revenue_share": 0.25,
        "stars_product_share": 0.25,
        "stars_count": 42,
        "total_products": 42,
        "optimized_at": "2026-11-02T09:30:00.000Z"
      },
      "strategy_adjustments": {
        "margin_poas": {
          "enabled": false,
          "margin_value_kind": "percent"
        },
        "target_anchor": {
          "enabled": false,
          "target_roas": null
        },
        "seasonality": {
          "enabled": false
        },
        "price_ratio": {
          "enabled": false
        },
        "inventory": {
          "optimise_for": "revenue",
          "clear_scope": "dead",
          "stockout_protection": true,
          "stability_days": 7,
          "ads_influence": 1,
          "business_influence": 1,
          "stock_influence": 1
        }
      },
      "weather_country": "NL"
    },
    "settings_source": "legacy_property",
    "settings_version": 0,
    "settings_hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  },
  "request_id": "req_01J365TMRYHPP8CQGDN3E94S9E"
}
```

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

## Before you call

Read them with [`settings.get`](/docs/api/settings/get) first, send the whole `labelizer_settings` object with your changes, and send its `settings_version` as `If-Match: "<settings_version>"` (leave the header out only when `settings_version` is null, meaning nothing was saved yet). A 409 settings_conflict means someone else saved in between: read again, reapply the change and retry. The saved settings reach the feed at the nightly run, or now with [`feed.generate`](/docs/api/settings/feed-generate). Needs an editor or admin of the workspace.

## Path parameters

| Name         | Type          | Description                                                           |
| ------------ | ------------- | --------------------------------------------------------------------- |
| `propertyId` | string (uuid) | A property_id from [`properties.list`](/docs/api/account/properties-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. |

## Body

| Name                                                                     | Type            | Required | Description                                                                                                                                                                                                                                                                                                            |
| ------------------------------------------------------------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `labelizer_settings`                                                     | object          | Yes      | Read them with [`settings.get`](/docs/api/settings/get) first, send the whole `labelizer_settings` object with your changes, and send its `settings_version` as `If-Match: "<settings_version>"` (leave the header out only when `settings_version` is null, meaning nothing was saved yet).                                |
| `labelizer_settings.weights`                                             | object          | Yes      | How much each signal counts in a product's score. Send back what [`settings.get`](/docs/api/settings/get) returned unless you mean to change it.                                                                                                                                                                            |
| `labelizer_settings.weights.w_ctr`                                       | number          | Yes      | Weight of click-through rate in a product's score.                                                                                                                                                                                                                                                                     |
| `labelizer_settings.weights.w_cvr`                                       | number          | Yes      | Weight of conversion rate in a product's score.                                                                                                                                                                                                                                                                        |
| `labelizer_settings.weights.w_roas`                                      | number          | Yes      | Weight of ROAS in a product's score.                                                                                                                                                                                                                                                                                   |
| `labelizer_settings.weights.w_revenue`                                   | number          | Yes      | Weight of revenue in a product's score.                                                                                                                                                                                                                                                                                |
| `labelizer_settings.weights.w_click_rank`                                | number          | Yes      | Weight of click rank in a product's score.                                                                                                                                                                                                                                                                             |
| `labelizer_settings.weights.w_click_boost`                               | number          | Yes      | Weight of click boost in a product's score.                                                                                                                                                                                                                                                                            |
| `labelizer_settings.weights.w_conversions`                               | number          | Yes      | Weight of conversions in a product's score.                                                                                                                                                                                                                                                                            |
| `labelizer_settings.weights.w_cost_penalty`                              | number          | Yes      | Weight of cost penalty in a product's score.                                                                                                                                                                                                                                                                           |
| `labelizer_settings.weights.w_click_potential`                           | number          | Yes      | Weight of click potential in a product's score.                                                                                                                                                                                                                                                                        |
| `labelizer_settings.weights.w_impression_boost`                          | number          | Yes      | Weight of impression boost in a product's score.                                                                                                                                                                                                                                                                       |
| `labelizer_settings.weights.w_spend_share_boost`                         | number          | Yes      | Weight of spend share boost in a product's score.                                                                                                                                                                                                                                                                      |
| `labelizer_settings.saved_at`                                            | string          | Yes      | When the settings were last saved. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                                        |
| `labelizer_settings.min_clicks`                                          | number          | Yes      | Clicks a product needs before its results count; fewer means it is judged on potential.                                                                                                                                                                                                                                |
| `labelizer_settings.category_cols`                                       | array of string | Yes      | The product column that holds the category, for example `product_type_l1`; the first one is used.                                                                                                                                                                                                                      |
| `labelizer_settings.category_col_source`                                 | enum            | No       | Where the category column comes from: `merchant` (Merchant Center) or `auto`. One of `auto`, `merchant`.                                                                                                                                                                                                               |
| `labelizer_settings.saved_by_user_id`                                    | string          | Yes      | Who saved the settings last. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                                              |
| `labelizer_settings.roas_threshold_low`                                  | number          | Yes      | The ROAS below which a product with few clicks counts as low-performing.                                                                                                                                                                                                                                               |
| `labelizer_settings.min_conversions_for_growth`                          | number          | Yes      | Conversions a product needs before it can move up as a growing product.                                                                                                                                                                                                                                                |
| `labelizer_settings.penalty_no_conversion_or_revenue`                    | number          | Yes      | How much a product with clicks but no conversions or revenue loses in its score.                                                                                                                                                                                                                                       |
| `labelizer_settings.data_range`                                          | enum            | No       | How many days of Google Ads results the segments use: `L30D` is the last 30 days. One of `L7D`, `L14D`, `L30D`, `L45D`, `L60D`, `L75D`, `L90D`, `L180D`, `L365D`. Default `L30D`.                                                                                                                                      |
| `labelizer_settings.excluded_campaign_ids`                               | array of string | No       | Google Ads campaign ids whose results the segments leave out. Up to 500 items. Default `[]`.                                                                                                                                                                                                                           |
| `labelizer_settings.supplemental_feed_source_settings`                   | object          | No       | Where the supplemental feed writes the labels, as [`feed_source_settings.get`](/docs/api/settings/feed-source-settings-get) returns them.                                                                                                                                                                                   |
| `labelizer_settings.supplemental_feed_source_settings.product_segment`   | object          | Yes      | Where the supplemental feed writes the product segment.                                                                                                                                                                                                                                                                |
| `labelizer_settings.supplemental_feed_source_settings.category_priority` | object          | Yes      | Where the supplemental feed writes the category priority.                                                                                                                                                                                                                                                              |
| `labelizer_settings.supplemental_feed_source_settings.force_override`    | boolean         | No       | Write to a custom label that already holds product values from your own feed.                                                                                                                                                                                                                                          |
| `labelizer_settings.supplemental_feed_source_settings.custom_fields`     | any             | No       | Extra feed columns, as [`feed_source_settings.get`](/docs/api/settings/feed-source-settings-get) returns them.                                                                                                                                                                                                              |
| `labelizer_settings.auto_optimized`                                      | object          | No       | Set by Product Metrics' first run. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                                        |
| `labelizer_settings.auto_optimized.source`                               | string          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned. Always `first_labelizer_call`.                                                                                                                                                                          |
| `labelizer_settings.auto_optimized.mode`                                 | enum            | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned. One of `aggressive`, `standard`.                                                                                                                                                                        |
| `labelizer_settings.auto_optimized.target_stars_revenue_min`             | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.target_stars_revenue_max`             | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.target_stars_revenue_ideal`           | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.recommended_min_clicks`               | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.confidence`                           | enum            | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned. One of `high`, `medium`, `low`.                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.reason_code`                          | string          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.stars_revenue_share`                  | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.stars_product_share`                  | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.stars_count`                          | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.total_products`                       | number          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.auto_optimized.optimized_at`                         | string          | Yes      | Part of `auto_optimized`, set by Product Metrics. Send back what [`settings.get`](/docs/api/settings/get) returned.                                                                                                                                                                                                         |
| `labelizer_settings.strategy_adjustments`                                | object          | No       | Optional adjustments to the segmentation: margin (POAS), a target ROAS anchor, seasonality, price ratio and inventory. Default `{"margin_poas":{"enabled":false,"margin_value_kind":"percent"},"target_anchor":{"enabled":false,"target_roas":null},"seasonality":{"enabled":false},"price_ratio":{"enabled":false}}`. |
| `labelizer_settings.strategy_adjustments.margin_poas`                    | object          | No       | Judge products on margin (POAS) instead of revenue; `margin_value_kind` says whether margins are percentages or ratios. Default `{"enabled":false,"margin_value_kind":"percent"}`.                                                                                                                                     |
| `labelizer_settings.strategy_adjustments.target_anchor`                  | object          | No       | Anchor the segments on your target ROAS (`target_roas`). Default `{"enabled":false,"target_roas":null}`.                                                                                                                                                                                                               |
| `labelizer_settings.strategy_adjustments.seasonality`                    | object          | No       | Take seasonal patterns into account. Default `{"enabled":false}`.                                                                                                                                                                                                                                                      |
| `labelizer_settings.strategy_adjustments.price_ratio`                    | object          | No       | Take your price against competitors' prices into account. Default `{"enabled":false}`.                                                                                                                                                                                                                                 |
| `labelizer_settings.strategy_adjustments.inventory`                      | object          | No       | Inventory-aware segments: what to optimise for, stock-out protection and how long a new segment holds.                                                                                                                                                                                                                 |

## 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`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the write scope; connect again and allow it.",
    "details": {
      "required_scope": "write"
    }
  },
  "request_id": "req_01JPSQJGD2KDTZ53ME5W85YCXG"
}
```

| 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.                                                 |
| 409    | `settings_conflict`  | A 409 settings_conflict means someone else saved in between: read again, reapply the change and retry.                    |
| 429    | `rate_limited`       | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Settings and rules operations](/docs/api/settings)
