Delete records

Delete multiple records by their ID.

Required ACL: deleteObject

This helper method deletes multiple records from an index by their objectID. It constructs a Batch request with the deleteObject action and automatically sends requests in batches of 1,000.

Usage

C#

var response = await client.DeleteObjectsAsync(
  "ALGOLIA_INDEX_NAME",
  new List<string> { "1", "2" }
);

Parameter

C#

indexName · string · required

Index name from which to delete records.

objectIDs · IEnumerable · required

Object IDs for records to delete.

waitForTasks · bool · default: false

Whether to wait until all batch requests are done.

cancellationToken · cancellationToken · default: "default"

Parameter that can be used as a signal to cancel the request.

requestOptions · RequestOptions

Additional request options.