Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Searchandising by User Request Data

Delete refined tag

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

Delete a refined tag.

delete/v1/refined_tags/{tag_name}/{tag_value}

Path parameters

tag_namestring required
tag_valuestring required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
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

Response

OK

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 tag

next_review_atstring date-time

The date of the next review

tag_namestring required
tag_valuestring required

Example response

{
  "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",
  "tag_name": "color",
  "tag_value": "red",
  "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
      }
    }
  ],
  "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"
        ]
      }
    }
  ],
  "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
  }
}