POST /1/dictionaries/{dictionaryName}/batch

Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Servers

https://{appId}.algolia.net
https://{appId}-1.algolianet.com
https://{appId}-2.algolianet.com
https://{appId}-3.algolianet.com
https://{appId}-dsn.algolia.net

Path parameters

Name Type Required Description

dictionaryName

String

Yes

Dictionary type in which to search.

Possible values:

"plurals"
"stopwords"
"compounds"

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`requests[]`	Array	Yes	List of additions and deletions to your dictionaries.
`requests[].action`	String	Yes	Actions to perform. Possible values: `"addEntry"` `"deleteEntry"`
`requests[].body`	Object	Yes	Dictionary entry.
`requests[].body.word`	String	No	Matching dictionary word for `stopwords` and `compounds` dictionaries.
`requests[].body.type`	String	No	Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom). Possible values: `"standard"` `"custom"`
`requests[].body.objectID`	String	Yes	Unique identifier for the dictionary entry.
`requests[].body.state`	String	No	Whether a dictionary entry is active. Possible values: `"disabled"` `"enabled"` Default value: "enabled"
`requests[].body.decomposition[]`	Array	No	Invividual components of a compound word in the `compounds` dictionary.
`requests[].body.language`	String	No	ISO code for a supported language. Possible values: `"eu"` `"pt-br"` `"ky"` `"fo"` `"ku"` `"ns"` `"bg"` `"ps"` `"qu"` `"no"` `"tr"` `"id"` `"tn"` `"cy"` `"nb"` `"en"` `"lt"` `"mr"` `"uz"` `"af"` `"sv"` `"pt"` `"mn"` `"ca"` `"ro"` `"sq"` `"mi"` `"az"` `"ga"` `"ka"` `"ar"` `"cs"` `"es"` `"hu"` `"zh"` `"eo"` `"is"` `"ms"` `"fi"` `"ru"` `"ko"` `"sw"` `"hi"` `"de"` `"tt"` `"ur"` `"nl"` `"pl"` `"tl"` `"th"` `"hy"` `"et"` `"ta"` `"bn"` `"it"` `"fr"` `"lv"` `"mt"` `"el"` `"gl"` `"kk"` `"he"` `"da"` `"fa"` `"ja"` `"sk"` `"uk"` `"te"`
`requests[].body.words[]`	Array	No	Matching words in the `plurals` dictionary including declensions.
`clearExistingDictionaryEntries`	Boolean	No	Whether to replace all custom entries in the dictionary with the ones sent with this request. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.