PARSER GUIDES

Update Parser

PATCH

/api/v1/parsers/{parserId}

Update safe customer-facing parser settings.

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

Request Body

application/json

name?string

description?string

isActive?boolean

acceptedFileTypes?array<string\>

Accepted file MIME type strings.

confidenceScores?object

markdownParsing?object

Enable Retab Markdown parsing for one additional PARSER credit per processed page.

advancedTableExtraction?string

Value in"disabled" | "auto" | "enabled"

dataExtractionMode?string

Value in"fast" | "balanced" | "accurate"

splitDocuments?SplitDocumentsSettings

PDF split settings for a parser. Split settings apply to PDF files imported through uploads, email, upload pages, embeds, API, URL imports, and Zapier.

classificationGate?ClassificationGateSettings

Document type rules for a parser. When enabled, PARSER checks each incoming document before extraction. A rule can either process only the listed document types or skip the listed types and process everything else. Skipped documents stay visible for review.

emailParsing?object

parsePages?string

PDF or email conversation pages to process, such as 1-3, 1,5,10, 2n-1, or 2n. Email page 1 is the newest visible message.

\[key: string\]?never

Response Body

200

application/json

400

application/json

curl -X PATCH "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c" \  -H "Content-Type: application/json" \  -d '{}'

200400

{
  "id": "d1458cd7-8692-488f-8b3f-0fddade05f9c",
  "name": "Invoice Parser",
  "description": "Extracts purchase order and invoice fields.",
  "type": "document",
  "isActive": true,
  "acceptedFileTypes": [
    {
      "mimeType": "application/pdf",
      "label": "PDF"
    }
  ],
  "settings": {
    "acceptedFileTypes": [
      {
        "mimeType": "application/pdf",
        "label": "PDF"
      }
    ],
    "confidenceScores": {
      "enabled": true
    },
    "markdownParsing": {
      "enabled": true
    },
    "advancedTableExtraction": "disabled",
    "dataExtractionMode": "fast",
    "splitDocuments": {
      "enabled": true,
      "mode": "everyXPages",
      "everyXPages": 5,
      "pageRanges": "1, 3, 7-9",
      "instructions": "Each invoice starts with an invoice number at the top.",
      "partitionKey": "transactions.transaction_date",
      "partitionKeySource": "parserField"
    },
    "classificationGate": {
      "enabled": true,
      "mode": "allow",
      "labels": [
        "Invoice",
        "Purchase Order"
      ],
      "instructions": "Only accept vendor invoices, not support tickets.",
      "costPerDocument": 0.1
    },
    "emailParsing": {
      "parseEmailBody": true,
      "mergeEmailAttachments": true,
      "includeEmailSubjectBody": true,
      "attachmentFileTypes": [
        "string"
      ],
      "senderFilter": {
        "mode": "disabled",
        "rules": [
          {
            "type": "email",
            "value": "contact@parser.example"
          },
          {
            "type": "domain",
            "value": "example.com"
          }
        ]
      }
    },
    "parsePages": "string"
  },
  "createdAt": "2026-01-23T18:11:47.319Z",
  "updatedAt": "2026-01-23T18:12:29.860Z",
  "counts": {
    "totalDocuments": 128,
    "folders": 4
  }
}

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