Create or update rules

Create or update multiple rules.

If a rule with the specified object ID doesn’t exist, Algolia creates a new one. Otherwise, existing rules are replaced.

This operation is subject to indexing rate limits.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import { algoliasearch } from 'algoliasearch';

//
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

const response = await client.saveRules({
  indexName: 'ALGOLIA_INDEX_NAME',
  rules: [
    {
      objectID: 'a-rule-id',
      conditions: [{ pattern: 'smartphone', anchoring: 'contains' }],
      consequence: { params: { filters: 'brand:apple' } },
    },
    {
      objectID: 'a-second-rule-id',
      conditions: [{ pattern: 'apple', anchoring: 'contains' }],
      consequence: { params: { filters: 'brand:samsung' } },
    },
  ],
  forwardToReplicas: false,
  clearExistingRules: true,
});
Did you find this page helpful?
JavaScript API clients v5