Skip to main content
This page documents an earlier version of the API client. For the latest version, see Delete all synonyms.
Required ACL: editSettings Don’t use this method to replace all synonyms in your production indices. Doing so causes a short downtime during which the index has no synonyms. Instead, use saveSynonyms with the replaceExistingSynonyms option to replace all synonyms without downtime.

​
Examples

index.ClearSynonyms(forwardToReplicas: true);

// Asynchronous
await index.ClearSynonymsAsync(forwardToReplicas: true);

​
Parameters

​
forwardToReplicas
boolean
default:false
Whether to delete all synonyms from all replicas of the index.

​
Response

​
taskID
integer
The task ID used with the waitTask method.
​
updatedAt
string
Date at which the indexing job has been created.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
⌘I