Delete Synonym | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

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

About this method

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

Examples

1
2
3
4
5
// Delete and forward to replicas

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

1
2
3
4
# Delete and forward to replicas
index.delete_synonym('a-unique-identifier', {
    'forwardToReplicas': True
})

1
2
3
4
5
6
7
8
9
10
11
12
// Delete and forward to replicas
index.deleteSynonym(
  'a-unique-identifier',
  {
    forwardToReplicas: true
  },
  (err, content) => {
    if (err) throw err;

    console.error(err);
  }
);

1
2
# Delete and forward to replicas
index.delete_synonym('a-unique-identifier', forward_to_replicas=True)

1
2
3
4
index.DeleteSynonym("a-unique-identifier", forwardToReplicas: true);

// Asynchronous
await index..DeleteSynonymAsync("a-unique-identifier", forwardToReplicas: true);

1
2
3
4
5
6
7
// Delete and forward to replicas
boolean forwardToReplicas = true;

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

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

1
2
forwardToReplicas := opt.ForwardToReplicas(true)
res, err := index.DeleteSynonym("a-unique-identifier", forwardToReplicas)

1
2
3
4
// Delete and forward to replicas
client.execute {
  delete synonym "a-unique-identifier" from "index_name" and forwardToReplicas
}

1
index.deleteSynonym(ObjectID("myID"), forwardToReplicas = true)

Parameters

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

1
2
3
4
{
  "deletedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}