Update dictionary settings

Turns standard stop word dictionary entries on or off for a given language.

PUT /1/dictionaries/*/settings

curl

cURL

curl --request PUT \
  --url 'https://algolia_application_id.algolia.net/1/dictionaries/*/settings' \
  --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 '{"disableStandardEntries":{"plurals":{"fr":false},"stopwords":{"fr":false},"compounds":{"fr":false}}}'

200

{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z"
}

Required ACL: editSettings

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

Turn on or off the built-in Algolia stop words for a specific language.

disableStandardEntries · object · required

Key-value pairs of supported language ISO codes and boolean values.

Show child attributes

disableStandardEntries. plurals · object

Key-value pair of a language ISO code and a boolean value.

Show child attributes

disableStandardEntries.plurals. {key} · boolean

Example:

{ "fr": false }

disableStandardEntries. stopwords · object

Key-value pair of a language ISO code and a boolean value.

Show child attributes

disableStandardEntries.stopwords. {key} · boolean

Example:

{ "fr": false }

disableStandardEntries. compounds · object

Key-value pair of a language ISO code and a boolean value.

Show child attributes

disableStandardEntries.compounds. {key} · boolean

Example:

{ "fr": false }

Response

200

application/json

OK

Response, taskID, and update timestamp.

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001

updatedAt · string · required

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"