v4

OpenAPI 3.1.02026-08-01166346466.7 KB

stores

Update a search rule

Update a search rule by ID.

Args: store_identifier: The ID or name of the store rule_id: The ID of the search rule to update rule_update: SearchRuleUpdateParams object containing the fields to update

Returns: SearchRuleResponse: The updated search rule details

put/v1/stores/{store_identifier}/rules/{rule_id}

Path parameters

string required

string uuid required

The ID or name of the store

rule_idstring uuid required

The ID of the search rule to update

Request body

querystring nullable

The query pattern to match

Example request

{
  "rules": [
    {
      "substitution": "query1"
    }
  ]
}

Response

The updated search rule

idstring required

The search rule ID

object'search_rule'

The object type

querystring required

The query pattern

store_idstring required

The store ID

created_atstring date-time required

When the rule was created

updated_atstring date-time required

When the rule was last updated

Example response

{
  "rules": [
    {
      "substitution": "query1"
    }
  ]
}