POST /1/indexes/{indexName}/rules/batch

Name of the index on which to perform the operation.

Default value: "application/json"

Whether existing rules should be deleted before adding this batch.

Whether changes are applied to replica indices.

Description of the rule's purpose to help you distinguish between different rules.

Conditions that trigger a rule.

Some consequences require specific conditions or don't require any condition. For more information, see Conditions.

Filters that trigger the rule.

You can add add filters using the syntax facet:value so that the rule is triggered, when the specific filter is selected. You can use filters on its own or combine it with the pattern parameter.

Which part of the search query the pattern should match:

• startsWith. The pattern must match the beginning of the query.
• endsWith. The pattern must match the end of the query.
• is. The pattern must match the query exactly.
• contains. The pattern must match anywhere in the query.

Empty queries are only allowed as patterns with anchoring: is.

Possible values:

• "startsWith"
• "contains"
• "is"
• "endsWith"

An additional restriction that only triggers the rule, when the search has the same value as ruleContexts parameter. For example, if context: mobile, the rule is only triggered when the search request has a matching ruleContexts: mobile. A rule context must only contain alphanumeric characters.

Whether the pattern should match plurals, synonyms, and typos.

Default value: false

Query pattern that triggers the rule.

You can use either a literal string, or a special pattern {facet:ATTRIBUTE}, where ATTRIBUTE is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with pattern: {facet:genre}, the rule is triggered when users search for a genre, such as "comedy".

Effect of the rule.

For more information, see Consequences.

Records you want to pin to a specific position in the search results.

You can promote up to 300 records, either individually, or as groups of up to 100 records each.

Whether promoted records must match an active filter for the consequence to be applied.

This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the color: red attribute, and the user filters the search for color: blue, the "red" record won't be shown.

Default value: false

Records you want to hide from the search results.

Unique record identifier.

A JSON object with custom data that will be appended to the userData array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.

Whether the rule is active.

Default value: true

Unique identifier of a rule object.

Time periods when the rule is active.

When the rule should stop to be active, in Unix epoch time.

When the rule should start to be active, in Unix epoch time.