Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Searchandising for Collections

Update refined collection

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchandising.refined_collections(w).

Update a refined collection. It will update only the fields that are present in the request.

patch/v1/refined_collections/{collection_id}

Path parameters

collection_idstring required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
response_section'results' | 'facets'
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

allow_automatic_rulesboolean

Specifies whether to allow automatic creation of rules

last_reviewed_atstring date-time

The date of the last review

last_reviewed_bystring

The user who last reviewed the refined filter

next_review_atstring date-time

The date of the next review

Example request

{
  "slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_id": "nike-shoes",
        "variation_slice": {
          "color": [
            "red"
          ]
        },
        "position": 1,
        "labels": {
          "promoted": true
        }
      }
    }
  ],
  "whitelist_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1
  },
  "blacklist_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ]
      }
    }
  ],
  "boost_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ],
        "boost": -5
      }
    }
  ],
  "content_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "data": {
          "banner_url": "https://example.com/banner.jpg"
        }
      }
    }
  ],
  "variation_slicing_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1,
    "rule": {
      "facet_names": [
        "color"
      ]
    }
  },
  "filters_slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "position_ranges": [
          {
            "start": 1,
            "end": 3
          }
        ]
      }
    }
  ],
  "allow_automatic_rules": true,
  "last_reviewed_at": "2024-03-06T16:05:19",
  "last_reviewed_by": "user@example.com",
  "next_review_at": "2024-04-06T16:05:19"
}

Response

OK

OR

Example response

{
  "slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_id": "nike-shoes",
        "variation_slice": {
          "color": [
            "red"
          ]
        },
        "position": 1,
        "labels": {
          "promoted": true
        }
      }
    }
  ],
  "whitelist_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1
  },
  "blacklist_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ]
      }
    }
  ],
  "boost_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "item_ids": [
          "nike-shoes"
        ],
        "boost": -5
      }
    }
  ],
  "content_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "data": {
          "banner_url": "https://example.com/banner.jpg"
        }
      }
    }
  ],
  "filters_slot_rules": [
    {
      "request_tag_value": "premium",
      "active": true,
      "start_time": "2024-03-06T16:05:19",
      "end_time": "2024-03-06T17:05:19",
      "campaign_id": 1,
      "rule": {
        "position_ranges": [
          {
            "start": 1,
            "end": 3
          }
        ]
      }
    }
  ],
  "variation_slicing_rule": {
    "request_tag_value": "premium",
    "active": true,
    "start_time": "2024-03-06T16:05:19",
    "end_time": "2024-03-06T17:05:19",
    "campaign_id": 1,
    "rule": {
      "facet_names": [
        "color"
      ]
    }
  }
}