Delete a search rule

Delete search rules. For external integration operations.

DELETE/api/v1/search/rules/{rule_id}

cURL request

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request DELETE \
  --url 'https://shop.onshopently.com/api/v1/search/rules/example?expected_version=1' \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN' \
  --header 'Idempotency-Key: example-delete_rule_api_v1_search_rules__rule_id__delete'

Response

{
  "data": {
    "deleted": true,
    "id": "example",
    "version": null
  },
  "meta": {
    "request_id": "example"
  }
}

Required permissions

Authentication: Access token
Available from: STANDARD
Key permission: Delete search rulessearch.rule:delete