Delete a folder

POST/api/folders/delete

Deletes a folder owned by the caller. mode: 'unfile' (default) makes its contents unfiled — no report is ever deleted. mode: 'cascade' permanently deletes the folder's contents (every report in it, all versions), and requires reports:delete in addition to reports:write — including for dryRun: true, since even the preview would leak how many reports are about to be destroyed. A cascade (non-dry-run) request must also include confirmTitle equal, character-for-character, to the folder's current title (compare to GitHub's delete-repo confirmation); a mismatch returns 400 CONFIRM_TITLE_MISMATCH and nothing is changed.

Body Parameters

idstringrequired

modestring

Default "unfile". One of unfile, cascade.

dryRunboolean

mode: 'cascade' only: preview the exact counts with zero writes. Default false.

confirmTitlestring

mode: 'cascade' (non-dry-run) only: must equal the folder's current title exactly.

const res = await fetch("https://leafpage.cc/api/folders/delete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer lp_…",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "f1a2b3c4d5e6f7g8",
    "mode": "cascade",
    "confirmTitle": "Weekly reports"
  }),
});
const data = await res.json();

$ch = curl_init("https://leafpage.cc/api/folders/delete");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer lp_…", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}');
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

import requests

res = requests.post(
    "https://leafpage.cc/api/folders/delete",
    headers={
        "Authorization": "Bearer lp_…",
        "Content-Type": "application/json",
    },
    json={
      "id": "f1a2b3c4d5e6f7g8",
      "mode": "cascade",
      "confirmTitle": "Weekly reports"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://leafpage.cc/api/folders/delete")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer lp_…"
req["Content-Type"] = "application/json"
req.body = '{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
data = JSON.parse(res.body)

package main

import (
  "net/http"
  "strings"
)

func main() {
  body := strings.NewReader(`{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}`)
  req, _ := http.NewRequest("POST", "https://leafpage.cc/api/folders/delete", body)
  req.Header.Set("Authorization", "Bearer lp_…")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
}

let client = reqwest::Client::new();
let res = client.post("https://leafpage.cc/api/folders/delete")
    .header("Authorization", "Bearer lp_…")
    .header("Content-Type", "application/json")
    .body(r#"{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}"#)
    .send()
    .await?;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://leafpage.cc/api/folders/delete"))
    .header("Authorization", "Bearer lp_…")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}"""))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://leafpage.cc/api/folders/delete");
request.Headers.Add("Authorization", "Bearer lp_…");
request.Content = new StringContent("""{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}""", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

curl -X POST "https://leafpage.cc/api/folders/delete" \
  -H "Authorization: Bearer lp_…" \
  -H "Content-Type: application/json" \
  -d '{"id":"f1a2b3c4d5e6f7g8","mode":"cascade","confirmTitle":"Weekly reports"}'

Response200

{
  "ok": true,
  "deletedLeaves": 5,
  "deletedVersions": 8
}