Skip to main content
POST
/
1
/
indexes
/
{indexName}
/
synonyms
/
batch
curl
curl --request POST \
  --url 'https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/synonyms/batch?forwardToReplicas=true&replaceExistingSynonyms=true' \
  --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 '[{"objectID":"synonymID","type":"onewaysynonym","synonyms":["vehicle","auto"],"input":"car","word":"car","corrections":["vehicle","auto"],"placeholder":"<Street>","replacements":["street","st"]}]'
{
  "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

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Query Parameters

​
forwardToReplicas
boolean

Whether changes are applied to replica indices.

​
replaceExistingSynonyms
boolean

Whether to replace all synonyms in the index with the ones sent with this request.

Body

application/json · object[]

Matching synonyms.

​
objectID
string
required

Unique identifier of a synonym object.

Example:

"synonymID"

​
type
enum<string>
required

Synonym type.

Available options:
synonym,
onewaysynonym,
altcorrection1,
altcorrection2,
placeholder,
oneWaySynonym,
altCorrection1,
altCorrection2
Example:

"onewaysynonym"

​
synonyms
string[]

Words or phrases considered equivalent.

Example:
["vehicle", "auto"]
​
input
string

Word or phrase to appear in query strings (for onewaysynonyms).

Example:

"car"

​
word
string

Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).

Example:

"car"

​
corrections
string[]

Words to be matched in records.

Example:
["vehicle", "auto"]
​
placeholder
string

Placeholder token to be put inside records.

Example:

"<Street>"

​
replacements
string[]

Query words that will match the placeholder token.

Example:
["street", "st"]

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