API Reference / API Methods / Synonyms / Clear all synonyms

Feb. 26, 2019

Clear All Synonyms

Required API Key: any key with the editSettings ACL

Method signature

$index->clearSynonyms([
  'forwardToReplicas' => boolean
])

index.clear_synonyms(Boolean forwardToReplicas)

index.clearSynonyms(
  {
    forwardToReplicas: boolean
  },
  callback
);

index.clear_synonyms({
    'forwardToReplicas': bool
})'

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

suspend fun Index.clearSynonyms(
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.ClearSynonyms(
  forwardToReplicas: bool
)

index.clearSynonyms(bool forwardToReplicas)

index.ClearSynonyms()
index.ClearSynonyms(opt.ForwardToReplicas(bool forwardToReplicas))

clear.synonyms(of).index("toto").and(bool forwardToReplicas)

See code examples

About this method

Remove all synonyms from an index.

This is a convenience method to delete all synonyms at once.

This Clear All method should not be used on a production index to push a new list of synonyms because it will result in a short down period during which the index would have no synonyms at all. Instead, use the batch method (with replaceExistingSynonyms set to true) to atomically replace all synonyms of an index with no down time.

Examples