API clients / Dart / Search

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
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

import 'package:algolia_client_search/algolia_client_search.dart';

final client =
    SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

final response = await client.saveRules(
  indexName: "ALGOLIA_INDEX_NAME",
  rules: [
    Rule(
      objectID: "a-rule-id",
      conditions: [
        Condition(
          pattern: "smartphone",
          anchoring: Anchoring.fromJson("contains"),
        ),
      ],
      consequence: Consequence(
        params: ConsequenceParams(
          filters: "brand:apple",
        ),
      ),
    ),
    Rule(
      objectID: "a-second-rule-id",
      conditions: [
        Condition(
          pattern: "apple",
          anchoring: Anchoring.fromJson("contains"),
        ),
      ],
      consequence: Consequence(
        params: ConsequenceParams(
          filters: "brand:samsung",
        ),
      ),
    ),
  ],
  forwardToReplicas: false,
  clearExistingRules: true,
);
See full API reference
Did you find this page helpful?