PapermarkDocs
APIReferenceFolders

Delete a folder

Delete a folder. Refuses non-empty folders unless `cascade=true`, in which case every descendant folder and document is deleted.

DELETE
/v1/folders/{id}

Authorization

bearerAuth documents.write
AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: documents.write

Path Parameters

id*string

Query Parameters

cascade?|

When true, deletes the folder and every nested folder + document inside it. Without cascade=true a non-empty folder returns 409.

Default"false"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.papermark.com/v1/folders/string"
{
  "id": "clxy9abc1234567890",
  "object": "document",
  "deleted": true
}
{
  "error": {
    "code": "bad_request",
    "message": "The request body is not valid JSON.",
    "doc_url": "https://www.papermark.com/docs/api/errors#bad_request",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token. Include an `Authorization: Bearer <token>` header.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Token is missing required scope: links.write.",
    "doc_url": "https://www.papermark.com/docs/api/errors#forbidden",
    "details": null
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Link link_abcd1234 not found.",
    "doc_url": "https://www.papermark.com/docs/api/errors#not_found",
    "details": null
  }
}
Empty
{
  "error": {
    "code": "unprocessable_entity",
    "message": "Invalid request body.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unprocessable_entity",
    "details": {
      "formErrors": [],
      "fieldErrors": {
        "expires_at": [
          "Invalid datetime"
        ]
      }
    }
  }
}
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 30s.",
    "doc_url": "https://www.papermark.com/docs/api/errors#rate_limit_exceeded",
    "details": null
  }
}

Update a folder

Rename the folder or update its icon/color. Renaming rewrites the `path` of this folder and every descendant in a single transaction.

Move a folder

Reparent a folder. Refuses moves into the folder itself or any of its descendants, and refuses if the target parent already has a sibling with the same slug. Descendant `path`s are rewritten in a single transaction.