API Reference / API Methods / Indexing / Delete objects

Feb. 26, 2019

Delete Objects

Required API Key: any key with the deleteObject ACL

Method signature

$index->deleteObjects(array objectIds)
$index->deleteObjects(array objectIds, array requestOptions)

// delete a single object
$index->deleteObject(string objectID)
$index->deleteObject(string objectID, array requestOptions)

index.delete_objects(Array objectIds)
index.delete_objects(Array objectIds, request_options=Hash)

# delete a single object
index.delete_object(String objectID)
index.delete_object(String objectID, request_options=Hash)

index.deleteObjects(array objectIds, callback)

index.deleteObject(string objectID, callback) // delete a single object

index.delete_objects(list objectIds)
index.delete_objects(list objectIds, dict requestOptions)

# delete a single object
index.delete_object(string objectID)
index.delete_object(string objectID, dict requestOptions)

index.deleteObjects(withIDs: [String] objectIDs, completionHandler)
index.deleteObjects(
  withIDs: [String] objectIDs,
  requestOptions: RequestOptions requestOptions,
  completionHandler
)

// delete a single object
index.deleteObject(withID: String objectID, completionHandler)
index.deleteObject(
  withID: String objectID,
  requestOptions: RequestOptions  requestOptions,
  completionHandler
)

suspend fun Index.deleteObject(
    objectID: ObjectID,
    requestOptions: RequestOptions? = null
): DeletionObject

suspend fun Index.deleteObjects(
    objectIDs: List<ObjectID>,
    requestOptions: RequestOptions? = null
): ResponseBatch

index.deleteObjectsAsync(Collection<String> objectIds, completionHandler);
index.deleteObjectsAsync(Collection<String> objectIds, RequestOptions requestOptions, completionHandler);

// delete a single object
index.deleteObjectAsync(String objectID, completionHandler);
index.deleteObjectAsync(String objectID, RequestOptions requestOptions, completionHandler);

index.DeleteObjects(
  IEnumerable<String> objectIds,

  // All the following parameters are optional
  requestOptions: RequestOptions
);

// delete a single object
index.DeleteObject(
  String objectID,
  // All the following parameters are optional
  requestOptions: RequestOptions
);

index.deleteObjects(List<String> objectIds);
index.deleteObjects(List<String> objectIds, RequestOptions requestOptions);

// delete a single object
index.deleteObject(String objectID);
index.deleteObject(String objectID, RequestOptions requestOptions);

index.DeleteObjects([]String objectIDs)
index.DeleteObjects([]String objectIDs, RequestOptions requestOptions)

// delete a single object
index.DeleteObject(String objectID)
index.DeleteObject(String objectID, RequestOptions requestOptions)

delete from "index_name" objectIds objectIDs
delete from "index_name" objectIds objectIDs options requestOptions

// delete a single object
delete from "index_name" objectId objectID
delete from "index_name" objectId objectID options requestOptions

See code examples

About this method

Remove objects from an index using their object ids.

This method enables you to remove one or more objects from an index.

There are 2 methods available to delete objects:

this one, which uses an objectID to identify objects
and delete by, which uses filters to identify objects

Note: This method also has a singular version.

Examples

Delete multiple objects using their `objectID`s

Copy

$index->deleteObjects(["myID1", "myID2"]);

Delete a single object

Copy

$index->deleteObject('myID');

Delete multiple objects and send extra http headers

Copy

$objectIDs = [/* objectIDs */];

$index->deleteObjects($objectIDs, [
  'X-Forwarded-For' => '94.228.178.246'
]);

RequestOptions requestOptions = new RequestOptions
{
    Headers = new Dictionary<string,string>{ { "X-Algolia-User-ID", "user123" } }
};

index.DeleteObject("myID", requestOptions);

// Asynchronous
await index.DeleteObjectAsync("myID", requestOptions);

RequestOptions requestOptions = 
  new RequestOptions().addExtraHeader("X-Algolia-User-ID", "user123");

// Sync version
index.deleteObjects(
  Arrays.asList("myID1", "myID2"),
  requestOptions
);

// Async version
index.deleteObjectsAsync(
  Arrays.asList("myID1", "myID2"),
  requestOptions
);

val objectIDS = listOf(ObjectID("myID1"), ObjectID("myID2"))
val requestOptions = requestOptions {
    headerAlgoliaUserId(UserID("user123"))
}

index.deleteObjects(objectIDS, requestOptions)

Parameters

`objectIDs`	type: list Required List of objectIDs to delete.
`requestOptions`	type: key value mapping default: No request options Optional A mapping of request options to send along with the query.
`objectID`	type: integer\|string Required The objectID of the object to delete.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy
{
  "objectIDs": [
    "myObjectID1",
    "myObjectID2"
  ],
  "taskID": 678,
}

`objectIDs`	list List of the objectIDS of the deleted objects.
`taskID`	integer The taskID used with the waitTask method.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Delete Objects

About this method

Examples

Delete multiple objects using their objectIDs

Delete a single object

Delete multiple objects and send extra http headers

Parameters

Response

JSON format

Did you find this page helpful?

On this page

Delete multiple objects using their `objectID`s