Api clients / JavaScript / V3 / Methods

Jan. 22, 2021

Delete Objects | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the deleteObject ACL

Method signature

index.deleteObjects(array objectIds, callback)

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

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

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

Delete a single object

Copy

Copy
$index->deleteObject('myID');

Delete multiple objects and send extra HTTP headers

Copy

Copy
$objectIDs = [/* objectIDs */];

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

Copy
client.setExtraHeader('X-Forwarded-For', '94.228.178.246');
index.deleteObjects(['myID1', 'myID2'], (err, content) => {
  if (err) throw err;

  console.log(content);
});

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

index.DeleteObject("myID", requestOptions);

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

Copy
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
);

Copy
extraHeaders := opt.ExtraHeaders(map[string]string{
	"X-Algolia-User-ID": "userID2",
})

res, err := index.DeleteObjects(
  []string{"myID1", "myID2"},
  extraHeaders,
)

Copy
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 [`requestOptions`](/doc/api-client/getting-started/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

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

Delete Objects | JavaScript API Client V3 (Deprecated)

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