Tool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.
enabledbooleanWhether the rule is active. Defaults to true.
validityarrayTime periods when the rule is active, specified as Unix timestamps.
object_idRequiredstringUnique identifier for the rule. This will be used as the rule's objectID.
conditionsarrayList of conditions that trigger the rule. Some consequences don't require conditions. Max 25 conditions.
index_nameRequiredstringName of the index in which to save the rule.
consequenceRequiredobjectEffect of the rule when conditions are met. Must include at least one consequence property.
descriptionstringHuman-readable description of the rule's purpose.
forward_to_replicasbooleanWhether to apply changes to replica indices. Defaults to false.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.