Bulk Delete

Deletes documents matching a set of filter predicates.

POST /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete

Bulk Delete

cURL

curl --request POST \
  --url https://api.cludo.com/api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Url": {
    "operator": "Eq",
    "values": [
      "https://www.cludo.com"
    ]
  },
  "Date_date": {
    "operator": "Gte",
    "values": [
      "2023/07/19"
    ]
  }
}
'

200

{
  "success": true,
  "deleted": 123,
  "failed": 123,
  "reason": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

customerId · integer · required

Your Cludo Customer ID (same as in MyCludo and Basic auth username).

crawlerId · integer · required

Crawler (content source) ID from MyCludo.

Body

application/json

Filter predicates keyed by indexed field name — use the same field names you set inside fields when pushing documents (e.g. Title, Url, Category, Date). Each value describes a comparison. Multiple filters are combined with logical AND.

{key} · object

Show child attributes

Response

200

application/json

Bulk delete completed.

success · boolean

True when the bulk job completed without fatal errors.

deleted · integer

Documents removed matching the filter.

failed · integer

Documents that could not be deleted (partial failures).

reason · string | null

Error or warning text when success is false or failed > 0.