PARSER GUIDES

Delete Folder

DELETE

/api/v1/parsers/{parserId}/folders/{folderId}

Delete a folder. By default, documents in the folder are moved out of the folder. Set deleteDocuments=true to delete the folder's documents as well.

Authorization

bearerAuth

authorization: <token>

Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')

In: header

Path Parameters

parserId — string

The ID of the parser

Format: uuid

folderId — string

The ID of the folder

Format: uuid

Query Parameters

deleteDocuments?boolean

Delete documents in the folder instead of moving them out.

Defaultfalse

Request Body

application/json

deleteDocuments?boolean

Delete documents in the folder instead of moving them out.

Defaultfalse

Response Body

200

application/json

401

application/json

404

application/json

curl -X DELETE "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c/folders/76e4f0ef-15d0-4bde-8c0e-43d361c0795c" \  -H "Content-Type: application/json" \  -d '{}'

200401404

{
  "success": true,
  "deletedDocuments": 0,
  "movedDocuments": 24
}

{
  "error": true,
  "message": "Parser ID mismatch"
}

{
  "error": true,
  "message": "Document not found",
  "notFound": [
    {
      "type": "documentId",
      "value": "string"
    }
  ]
}