Delete synonym

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

$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)

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

1
2
3
index.delete_synonym('a-unique-identifier', {
    'forwardToReplicas': true
})

1
2
3
4
5
index.deleteSynonym('a-unique-identifier', {
  forwardToReplicas: true
}).then(() => {
  // done
});

1
index.delete_synonym('a-unique-identifier', forward_to_replicas=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
index.deleteSynonym(ObjectID("a-unique-identifier"), forwardToReplicas = 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
boolean forwardToReplicas = true;

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

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

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

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

1
2
3
algolia synonyms delete <INDEX> \
        --synonym-ids "a-unique-identifier" \
        --forward-to-replicas

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