Delete multiple documents

info

• client write secret is required for adding, modifying, or deleting data.

Overview

Path

DELETE/v1/collections/{collectionName}/documents

• Delete multiple Documents at once.

Example

---

curl -X DELETE https://api.invector.co/v1/collections/{collectionName}/documents \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     -d '{
       "_ids": ["1", "2", "3"]
     }'

Authorization

---

Authorization

BasicBasic authorization at Header. Base64 encoding required

client_id

string

client_secret

string

example

 curl -X DELETE https://api.invector.co/v1/collections/{collectionName}/documents \
      -H "Content-Type: application/json" \
      -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     ...

Path Parameters

---

collectionName

string

Request Body

---

_ids

array of stringArray of documents to be created.

example

{
  "_ids": ["1", "2", "3"]
}

Response Body

---

documents

array of objectInformation about deleted document

_id

stringUnique Document ID.

deleted

booleanWhether document is deleted or not.

example

{
  "documents": [
    {
      "_id": "1",
      "deleted": true,
    },
    {
      "_id": "2",
      "deleted": true,
    },
    {
      "_id": "3",
      "deleted": true,
    }
  ]
}