This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

Required API Key: any key with the deleteObject ACL

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

// Delete a single record
$index->deleteObject(string objectID)
$index->deleteObject(string objectID, array requestOptions)

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.

About this method

Delete records from an index using their objectID.

You can use two methods to delete records:

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

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

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

When deleting large numbers of records be aware of the rate limitations on these processes and the impact on your analytics data.

This method also has a singular version.

Examples

Read the Algolia CLI documentation for more information.

Delete multiple records

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

Delete a single record

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 request options to send along with the query.

objectID
type: integer|string
Required

The objectID of the record to delete.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

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

List of the objectIDs of the deleted records.

taskID
integer

The taskID used with the waitTask method.

Did you find this page helpful?