Skip to content
Leadtime
English
Esc
↑↓navigate↵open⌘Jpreview

Delete a project documentation node

Soft deletes a project documentation page or folder subtree after explicit confirmation. Deleted nodes no longer accept reads or writes.

Deletion behavior:

  • Call the delete-preview endpoint first to show active page and folder counts
  • Pass confirmed=true and the unchanged previewToken to delete the complete subtree atomically
  • A changed subtree returns HTTP 409. Get a new preview before retrying
  • Deleted nodes disappear from list, tree, detail, and update operations
  • Data remains soft-deleted for recovery or audit purposes

Permissions:

  • Requires “manageDocumentation” permission for the project
DELETE/projects/documentation/{id}
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstring<uuid>required

Project documentation page or folder UUID. This parameter does not accept a project short identifier.

Query parameters
confirmedbooleanrequired
previewTokenstringrequired

Opaque token returned by the latest delete preview.

Responses
200
successbooleanrequired

Operation success flag

400

The documentation node identifier or deletion confirmation is invalid.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties
One of:
string
string
object
object
messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties
One of:
string
string
string[]
Array of string
string
object
object
statusCodenumberrequired

HTTP status code for this response.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

The node does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties
One of:
string
string
object
object
messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties
One of:
string
string
string[]
Array of string
string
object
object
statusCodenumberrequired

HTTP status code for this response.

409

The active subtree changed after preview. Get a new preview before retrying.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties
One of:
string
string
object
object
messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties
One of:
string
string
string[]
Array of string
string
object
object
statusCodenumberrequired

HTTP status code for this response.

Try it
Server
Authorization
Parameters
Request
curl -X DELETE "https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000?confirmed=true&previewToken=string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "success": true
}