PARSERGet Started

PARSER GUIDES

Update Folder

PATCH

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

Update a parser folder.

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

Request Body

application/json

name?string

color?string|null

parentId?string|null

Parent folder ID, or null to move the folder to root.

hasAutoAssign?boolean

autoAssignment?object|boolean|null

Optional folder auto-assignment configuration.

\[key: string\]?never

Response Body

200

application/json

400

application/json

401

application/json

404

application/json

409

application/json

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

200400401404409

{
  "id": "76e4f0ef-15d0-4bde-8c0e-43d361c0795c",
  "name": "Invoices",
  "slug": "invoices",
  "color": "#2563eb",
  "parentId": null,
  "documentCount": 24,
  "directDocumentCount": 12,
  "childFolderCount": 3,
  "pathIds": [
    "76e4f0ef-15d0-4bde-8c0e-43d361c0795c"
  ],
  "pathNames": [
    "Invoices"
  ],
  "pathLabel": "Invoices",
  "depth": 0,
  "hasAutoAssign": false,
  "autoAssignment": null,
  "createdAt": "2026-01-23T18:11:47.319Z",
  "updatedAt": "2026-01-23T18:12:29.860Z"
}
{
  "error": true,
  "message": "Parser ID mismatch"
}
{
  "error": true,
  "message": "Parser ID mismatch"
}
{
  "error": true,
  "message": "Document not found",
  "notFound": [
    {
      "type": "documentId",
      "value": "string"
    }
  ]
}
{
  "error": true,
  "message": "Parser ID mismatch"
}
Create Folder POSTCreate a folder for a parser.Open guide → Delete Folder DELETEDelete 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.Open guide →