Delete synonym

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

Required ACL: editSettings

Examples

C#

index.DeleteSynonym("a-unique-identifier", forwardToReplicas: true);

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

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

boolean forwardToReplicas = true;

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

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

index
  .deleteSynonym("a-unique-identifier", {
    forwardToReplicas: true,
  })
  .then(() => {
    // done
  });

index.deleteSynonym(ObjectID("a-unique-identifier"), forwardToReplicas = true)

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

index.delete_synonym("a-unique-identifier", forward_to_replicas=True)

index.delete_synonym(
  "a-unique-identifier",
  {
    :"forwardToReplicas" => true
  }
)

client.execute {
  delete synonym "a-unique-identifier" from "index_name" and forwardToReplicas
}

  index.deleteSynonym(withID: "a-unique-identifier", forwardToReplicas: true) { result in
    if case .success(let response) = result {
      print("Response: \(response)")
    }
  }

Parameters

objectID · string · required

Object ID of the synonym to delete.

forwardToReplicas · boolean · default: false

Whether to delete the synonym also from all replicas of the index.

requestOptions · object

A mapping of request options to send along with the request.

Response

deletedAt · string

Date at which the indexing job has been created.

taskID · integer

The task ID used with the waitTask method.

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

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