v5

latestOpenAPI 3.1.02026-08-04166362486.5 KB
stores

Create search rule

Create a new search rule for a store.

Args: store_identifier: The ID or name of the store rule_create: Search rule creation parameters

Returns: SearchRuleResponse: The created search rule details

post/v1/stores/{store_identifier}/rules

Path parameters

string required
OR
string uuid required

The ID or name of the store

Request body

querystring required

The query pattern to match

Example request

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

Response

The created 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"
    }
  ]
}