Update the configuration

Updates the configuration.

The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index, create a new configuration object for the index.

PUT /2/config

curl

cURL

curl --request PUT \
  --url https://ai-personalization.eu.algolia.com/2/config \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"indices":[{"index":"lorem","affinities":["lorem"],"source":{"type":"insights","events":{"viewDetails":[{"type":"view","subtype":"addToCart","name":"lorem"}],"viewListing":[{"type":"view","subtype":"addToCart","name":"lorem"}],"addToCart":[{"type":"view","subtype":"addToCart","name":"lorem"}],"purchase":[{"type":"view","subtype":"addToCart","name":"lorem"}]}}}],"personalizationReRanking":"none","profileType":"basic","features":{"realtime":{"enabled":true}}}'

200

{
  "status": 123,
  "errors": [
    {
      "code": "<string>",
      "index": "<string>",
      "message": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "index": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>"
}

Required ACL: search, browse, recommendation

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Body

application/json

indices · configurationParametersObject · object[] · required

Show child attributes

indices. index · string

indices. affinities · string[]

indices. source · source · object

Show child attributes

indices.source. type · enum<string> · required

Available options: insights

indices.source. events · object

Show child attributes

indices.source.events. viewDetails · object[] · required

Show child attributes

indices.source.events.viewDetails. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.viewDetails. name · string · required

indices.source.events.viewDetails. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. viewListing · object[] · required

Show child attributes

indices.source.events.viewListing. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.viewListing. name · string · required

indices.source.events.viewListing. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. addToCart · object[] · required

Show child attributes

indices.source.events.addToCart. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.addToCart. name · string · required

indices.source.events.addToCart. subtype · enum<string>

Available options: addToCart, purchase

indices.source.events. purchase · object[] · required

Show child attributes

indices.source.events.purchase. type · enum<string> · required

Available options: view, click, conversion

indices.source.events.purchase. name · string · required

indices.source.events.purchase. subtype · enum<string>

Available options: addToCart, purchase

personalizationReRanking · enum<string> · required

The impact that personalization has on the re-ranking of search results.

Available options: none, low, medium, high, maximum

profileType · enum<string> · required

The type of user profiles to generate.

Basic profiles are based on past behaviors, ensuring search results align with previous interests.

Available options: basic

features · object · required

Show child attributes

features. realtime · object

Show child attributes

features.realtime. enabled · boolean

Whether the realtime personalization feature is enabled.

Response

200

application/json

OK

status · number · required

errors · object[] · required

Show child attributes

errors. code · string · required

errors. index · string · required

errors. message · string · required

warnings · object[] · required

Show child attributes

warnings. code · string · required

warnings. index · string · required

warnings. message · string · required

message · string · required