Delete a collection

DELETE/api/v1/workspaces/{workspace_slug}/collections/{collection_id}/

Deletes a non-default collection. Pages are archived by default. Set archive_pages=false to preserve pages when deleting a public collection; pages in a private collection are always archived.

Path Parameters

workspace_slug:requiredstring

The workspace slug.

collection_id:requireduuid

The collection ID.

Query Parameters

archive_pages:optionalboolean

Whether to archive contained pages. Defaults to true.

Scopes

write or wiki.pages:write

Delete a collection

curl -X DELETE "https://api.plane.so/api/v1/workspaces/my-workspace/collections/0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10/?archive_pages=false" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests
url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10/"
response = requests.delete(url, headers={"X-API-Key": "your-api-key"}, params={"archive_pages": "false"})
print(response.status_code)

// Run this example server-side. Browser apps must call your backend to keep the API key secret.
const url =
  "https://api.plane.so/api/v1/workspaces/my-workspace/collections/0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10/?archive_pages=false";
const response = await fetch(url, {
  method: "DELETE",
  headers: { "X-API-Key": process.env.PLANE_API_KEY },
});
console.log(response.status);

Response204

No response body