Delete records matching a query

This operation doesn’t accept empty queries or filters.

It’s more efficient to get a list of object IDs with the browse operation, and then delete the records using the batch operation.

Usage

Required ACL: deleteIndex
1
2
3
4
5
6
7
8
9
10
11
import algoliasearch.api.SearchClient
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = client.deleteBy(
  indexName = "ALGOLIA_INDEX_NAME",
  deleteByParams = DeleteByParams(
    filters = Some("brand:brandName")
  )
)
Did you find this page helpful?
Scala API clients v2