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, Hash opts = {
  # any requestOptions
})

# delete a single object
index.delete_object(String objectID)
index.delete_object(String objectID, Hash opts = {
  # any requestOptions
})

index.deleteObjects(array objectIDs)

index.deleteObjects(array objectIDs, {
  // + any requestOptions
})

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

index.deleteObject(string objectID, {
  // + any requestOptions
})

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 objectIDs: [ObjectID],
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<BatchesResponse> -> Void
)

// delete a single object
index.deleteObject(
  withID objectID: ObjectID ,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<ObjectDeletion> -> Void
)

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

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

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

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.

About this method

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

Copy

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

Delete a single object

Copy

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

Parameters

Parameter	Description
`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. 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

Copy

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

        

Field	Description
`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?