Update a Parser

Endpoint: PATCH /v1/parsers/:id. Reference for updating the configuration or schema of an existing parser.

`PATCH /v1/parsers/:id`

Updates specific configuration parameters of an existing parser. This is the preferred method for making partial updates.

Path Parameters

Parameter	Type	Required	Description
`id`	`string`	✅	The unique ID of the parser to update.

Body Parameters

Parameter	Type	Required	Description
`name`	`string`	❌	Updated name for the parser (max 100 chars).
`description`	`string`	❌	Updated description text.
`result_mode`	`string`	❌	`one_per_file` or `one_per_page`. Maps to dashboard One document per file / One document per page.
`fields`	`array`	❌	Full replacement list of field definitions. Each field: `name` (required), `type` (optional: `string`, `number`, `boolean`, `date`, `array`, `object`), `description` (optional), `required` (optional boolean). Re-generates underlying parser schema.
`document_type`	`string \| null`	❌	Document type slug (e.g. `invoices`). Pass `null` to clear. See the Create Parser reference for valid slugs.

curl -X PATCH https://api.perfectparser.com/v1/parsers/prs_999 \
  -H "X-API-Key: pp_live_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description text."}'

Response 200 OK

{
  "parser": {
    "parser_id": "prs_999",
    "name": "Invoice Parser",
    "description": "Updated description text.",
    "result_mode": "one_per_file",
    "document_type": "invoices",
    "schema": {
      "type": "object",
      "properties": {
        "invoice_number": { "type": "string" },
        "total_amount": { "type": "number" }
      }
    },
    "fields": {
      "invoice_number": { "description": "" },
      "total_amount": { "description": "" }
    },
    "has_sample_file": true,
    "sample_file_id": "smp_123",
    "created_at": "2026-06-20T10:00:00.000Z",
    "updated_at": "2026-06-20T10:05:12.000Z"
  }
}

Common Error Responses

HTTP Status	Error Code	Description
`400`	`INVALID_PAYLOAD`	Request body validation failed or malformed JSON.
`401`	`UNAUTHORIZED`	Invalid or missing API key.
`404`	`PARSER_NOT_FOUND`	The requested parser does not exist or belongs to another account.
`409`	`CONFLICT`	A parser with this name already exists.

PATCH /v1/parsers/:id

Common Error Responses

On this page

`PATCH /v1/parsers/:id`