Skip to main content
POST
/
1
/
dictionaries
/
{dictionaryName}
/
batch
curl
curl --request POST \
  --url https://algolia_application_id.algolia.net/1/dictionaries/plurals/batch \
  --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 '{"clearExistingDictionaryEntries":false,"requests":[{"action":"addEntry","body":{"objectID":"828afd405e1f4fe950b6b98c2c43c032","language":"af","word":"the","words":["cheval","cheveaux"],"decomposition":["kopf","schmerz","tablette"],"state":"enabled","type":"custom"}}]}'
{
  "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.

Path Parameters

​
dictionaryName
enum<string>
required

Dictionary type in which to search.

Available options:
plurals,
stopwords,
compounds

Body

application/json

Request body for updating dictionary entries.

​
requests
batchDictionaryEntriesRequest · object[]
required

List of additions and deletions to your dictionaries.

​
clearExistingDictionaryEntries
boolean
default:false

Whether to replace all custom entries in the dictionary with the ones sent with this request.

Response

OK

Response, taskID, and update timestamp.

​
taskID
integer
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"

⌘I