Update index settings

Update the specified index settings.

Index settings that you don’t specify are left unchanged. Specify null to reset a setting to its default value.

For best performance, update the index settings before you add new records to your index.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
import { algoliasearch } from 'algoliasearch';

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

const response = await client.setSettings({
  indexName: 'ALGOLIA_INDEX_NAME',
  indexSettings: { attributesForFaceting: ['actor', 'filterOnly(category)', 'searchable(publisher)'] },
});
Did you find this page helpful?
JavaScript API clients v5