API client / Methods / Indexing
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)

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Delete objects from an index using their objectID.

You can use two methods to delete objects:

  • deleteObject (this method), which uses objectID to identify objects
  • deleteBy, which uses filters to identify objects.

Each object included in the batch counts as one operation. If you pass an objectID that doesn’t exist, it still counts as an operation because the engine doesn’t know if the record exists when attempting the operation.

Deleting all objects in an index doesn’t delete the index. To delete an index completely, including objects, settings, synonyms, and Rules, use the deleteIndex method.

This method also has a singular version.

Examples

Read the Algolia CLI documentation for more information.

Delete multiple objects

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

Delete a single object

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

Parameters

objectIDs
type: list
Required

List of objectIDs to delete.

requestOptions
type: key-value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the query.

objectID
type: integer|string
Required

The objectID of the object to delete.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

1
2
3
4
5
6
7
{
  "objectIDs": [
    "myObjectID1",
    "myObjectID2"
  ],
  "taskID": 678,
}
objectIDs
list

List of the objectIDs of the deleted objects.

taskID
integer

The taskID used with the waitTask method.

Did you find this page helpful?