Skip to main content
DELETE
/
api
/
v4
/
{customerId}
/
index
/
{crawlerId}
/
documents
Single Delete
curl --request DELETE \
  --url https://api.cludo.com/api/v4/{customerId}/index/{crawlerId}/documents \
  --header 'Authorization: Basic <encoded-value>'
{
  "deleted": 1
}

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.

Query Parameters

documentId
string
required

The document ID to delete — the same string you used as id when indexing. For most integrations this is the document's canonical URL (e.g. https://example.com/products/widget-pro). Because the value is usually a full URL, it must be URL-encoded in the query string (e.g. documentId=https%3A%2F%2Fexample.com%2Fproducts%2Fwidget-pro).

Response

Document deleted successfully.

deleted
enum<integer>

1 when the document was removed, 0 if nothing matched.

Available options:
0,
1
Example:

1