Batch Delete Objects

Delete up to 100 objects in one API request.

Endpoint

DELETE /v2/objects

Request

Body

---

A list of objects containing the objectType and objectId.

---

note

Each batch delete request can delete up to 100 new objects. Requests containing more than 100 objects will fail.

Batch deletes are atomic operations. If any error (client or server) is encountered during creation, none of the objects will be deleted. Batch delete requests can therefore be safely retried.

cURL

curl "https://api.warrant.dev/v2/objects" \
  -X DELETE \
  -H "Authorization: ApiKey YOUR_KEY" \
  --data-raw \
  '[{"objectType":"user","objectId":"d6ed6474-784e-407e-a1ea-42a91d4c52b9"},{"objectType":"user","objectId":"59ed2c60-6945-42dc-b770-d3a78212ffdf"}]'

Go

warrantToken, err := object.BatchDelete([]warrant.ObjectParams{
  {ObjectType: "user", ObjectId: "d6ed6474-784e-407e-a1ea-42a91d4c52b9"},
  {ObjectType: "user", ObjectId: "59ed2c60-6945-42dc-b770-d3a78212ffdf"},
})

Java

String warrantToken = client.deleteObjects(new BaseWarrantObject[]{
  new BaseWarrantObject("user", "d6ed6474-784e-407e-a1ea-42a91d4c52b9"),
  new BaseWarrantObject("user", "59ed2c60-6945-42dc-b770-d3a78212ffdf")
});

Node.js

DELETE /v2/objects

let warrantToken = await warrantClient.Object.batchDelete([
  {
    objectType: "user"
    objectId: "d6ed6474-784e-407e-a1ea-42a91d4c52b9",
  },
  {
    objectType: "user",
    objectId: "59ed2c60-6945-42dc-b770-d3a78212ffdf",
  },
]);

PHP

warrant_token = warrant.Object.batch_delete([
  {"objectType": "user", "objectId": "d6ed6474-784e-407e-a1ea-42a91d4c52b9"},
  {"objectType": "user", "objectId": "59ed2c60-6945-42dc-b770-d3a78212ffdf"},
])

Python

POST /v2/objects

warrant_token = Warrant::Object.batch_delete([
  { object_type: "user", object_id: "d6ed6474-784e-407e-a1ea-42a91d4c52b9" },
  { object_type: "user", object_id: "59ed2c60-6945-42dc-b770-d3a78212ffdf" }
])

Ruby

Response

Headers

---

Warrant-Token string

A unique transaction identifier for this write operation. Can be cached and passed on subsequent read requests.

---

200 OK