Replace refined query

put

https://ac.cnstrc.com/v1/refined_queries/{refined_query_id}

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

Replace a refined query. It will replace all existing rules associated with the specified refined query if there are any. It will also flip allow_automatic_rules to true (which is default) if attribute's value isn't submitted in the request.

Path Params

refined_query_id

int32

required

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

response_section

string

enum

Defaults to results

The section of the response to apply rules to, such as results or facets.

Allowed:

section

string

length between 1 and 100

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

string

length between 1 and 100

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

Body Params

slot_rules

array of objects

length ≤ 1000

The slotting rules attached to the refined query

Slot Rules

whitelist_rule

The whitelist rule attached to the refined query

blacklist_rules

array of objects

length ≤ 50

The blacklist rules attached to the refined query

Blacklist Rules

boost_rules

array of objects

The boost rules attached to the refined query. It is allowed to create maximum 50 manual and 50 automatic rules. The number of rules for each of the types includes both active and inactive rules

Boost Rules

content_rules

array of objects

length ≤ 50

The content rules attached to the refined query

Content Rules

variation_slicing_rule

The variation slicing rule attached to the refined query

filters_slot_rules

array of objects

length ≤ 5

The filters slot rules attached to the refined query

Filters Slot Rules

query

string

required

length between 1 and 100

allow_automatic_rules

boolean

Defaults to true

Specifies whether to allow automatic creation of rules

last_reviewed_at

date-time

The date of the last review

last_reviewed_by

string

The user who last reviewed the refined query

next_review_at

date-time

The date of the next review

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

404

Not Found

409

Conflict

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK