PUT /1/indexes/{indexName}/synonyms/{objectID}
If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
Otherwise, the existing synonym is replaced.
To add multiple synonyms in a single API request, use the batch operation.
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 |
|---|---|---|---|
indexName |
String | Yes |
Name of the index on which to perform the operation. |
objectID |
String | Yes |
Unique identifier of a synonym object. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
forwardToReplicas |
Boolean | No |
Whether changes are applied to replica indices. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
placeholder |
String | No |
Placeholder token to be put inside records. |
synonyms[] |
Array | No |
Words or phrases considered equivalent. |
input |
String | No |
Word or phrase to appear in query strings (for |
word |
String | No |
Word or phrase to appear in query strings (for |
type |
String | Yes |
Synonym type. Possible values:
|
objectID |
String | Yes |
Unique identifier of a synonym object. |
corrections[] |
Array | No |
Words to be matched in records. |
replacements[] |
Array | No |
Query words that will match the placeholder token. |
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.