Delete a Sitemap (cascade)

DELETE

/api/v2/sitemaps/{sitemap_id}

Soft-deletes a parent sitemap and all of its descendants. Only sitemaps with no parent (parent_id is None) can be deleted directly.
Attempting to delete a child sitemap directly is not allowed.

Purpose:

Enforces hierarchical deletion: only root/parent sitemaps can be deleted explicitly; children are deleted automatically via cascade.

Path Parameters:

sitemap_id (int): Parent sitemap identifier to delete.

Returns:

A success message; 404 when target is not found; 403 if trying to delete a child directly.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https:///api/v2/sitemaps/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Sitemap and its descendants marked as deleted",
    "data": {}
}

Toggle Sitemap Syncing

Get documents linked to a Sitemap