Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
This node operation deletes a synonym from an Algolia search index. Synonyms in Algolia are terms that the search engine treats as equivalent, improving search relevance by matching different words or phrases with similar meanings.
Use this node when you want to remove a specific synonym entry identified by its unique ID from a particular index. This is useful for maintaining and updating your search index's synonym list, ensuring outdated or incorrect synonyms do not affect search results.
Example use case:
If you previously added a synonym linking "car" and "automobile" but want to remove it because it no longer fits your search strategy, you can use this operation to delete that synonym by specifying its object ID and the index name.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index from which to delete the synonym. |
| Object ID | The unique identifier of the synonym object to delete. |
| Forward To Replicas | Boolean flag indicating whether the deletion should be forwarded to replica indices. |
Output
The output contains the JSON response from the Algolia API after attempting to delete the synonym. Typically, this will include status information about the deletion request.
The node does not output binary data.
Dependencies
- Requires an Algolia application with appropriate API credentials (API key and Application ID).
- The node must be configured with these credentials to authenticate requests.
- The Algolia API endpoint used is:
DELETE /1/indexes/{indexName}/synonyms/{objectID}.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Specifying a non-existent index name or synonym object ID will result in errors or no action.
- Network connectivity issues may prevent successful API calls.
Error messages:
- "Object not found" — The specified synonym ID does not exist in the given index.
- Authentication errors — Check that the API key credential is valid and has permissions to modify synonyms.
- Rate limit exceeded — Algolia enforces rate limits; if exceeded, wait before retrying.
Resolution tips:
- Verify the index name and synonym object ID are correct.
- Ensure the API key has sufficient permissions.
- Handle API rate limits gracefully in your workflow.