API Reference / API Methods / Synonyms / Delete synonym

Feb. 26, 2019

Delete Synonym

Required API Key: any key with the editSettings ACL

Method signature

$index->deleteSynonym(string objectID)

$index->deleteSynonym(string objectID, [
  // All the following parameters are optional
  forwardToReplicas => boolean
])

index.delete_synonym(String objectID, Boolean forwardToReplicas)

index.deleteSynonym(
  objectID,
  {
    forwardToReplicas: boolean
  },
  callback
)

index.delete_synonym(str objectID)

index.delete_synonym(str objectID, {
    // All the following parameters are optional
    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.deleteSynonym(
    objectID: ObjectID,
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): DeletionIndex

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.DeleteSynonym(
  String objectID,

  // All the following parameters are optional
  forwardToReplicas: bool
)

index.deleteSynonym(String objectID, bool forwardToReplicas)

index.DeleteSynonym(string objectID)
index.DeleteSynonym(string objectID, opt.ForwardToReplicas(bool forwardToReplicas))

delete.synonym(String objectID)
      .from(\"index_name\")
      .and(bool forwardToReplicas)

See code examples

About this method

Remove a single synonym from an index using its object id.

Examples

Copy

// Delete and forward to replicas

$index->deleteSynonym("a-unique-identifier", [
  'forwardToReplicas' => true
]);

// Delete and forward to replicas
index.deleteSynonym(
  'a-unique-identifier',
  {
    forwardToReplicas: true
  },
  (err, content) => {
    if (err) throw err;

    console.error(err);
  }
);

// Delete and forward to replicas
boolean forwardToReplicas = true;

index.deleteSynonym("a-unique-identifier", forwardToReplicas);

// Async
index.deleteSynonymAsync("a-unique-identifier", forwardToReplicas);

Parameters

`objectID`	type: string Required objectID of the synonym to delete
`forwardToReplicas`	type: boolean default: false optional Will delete synonym on all replicas. Without this parameter, or by setting it to false, the method still applies the change only to the specified index. If you want to forward the delete to your replicas you will need to set this parameter to true.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy
{
  "deletedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

`deletedAt`	string Date at which the indexing job has been created.
`taskID`	integer The taskID used with the waitTask method.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Delete Synonym

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page