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, Hash opts = {
  Boolean forwardToReplicas: false
})

index.deleteSynonym(string objectID)

index.deleteSynonym(string objectID, {
    // All the following parameters are optional
    forwardToReplicas: boolean,
    // any other requestOptions
})

index.delete_synonym(str objectID)

index.delete_synonym(str objectID, {
    // All the following parameters are optional
    forwardToReplicas: bool
})

index.deleteSynonym(
  withID objectID: ObjectID,
  forwardToReplicas: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<IndexDeletion> -> Void
)

suspend fun Index.deleteSynonym(
    objectID: ObjectID,
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): DeletionIndex

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

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

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

Examples

Read the Algolia CLI documentation for more information.

Copy

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

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

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
boolean forwardToReplicas = true;

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

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

Parameters

Parameter	Description
`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.
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the request.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

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

        

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