PARSER GUIDES

Update Review Stage

PATCH

/api/v1/parsers/{parserId}/review-stages/{stageId}

Update customer-facing review stage settings. Stages containing code rules cannot have rules changed through the public API.

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

stageId — string

The ID of the review stage

Request Body

application/json

name?string

reviewerInstructions?string|null

Optional plain-text guidance shown to the assigned reviewer. Set to null to clear it.

Lengthlength <= 500

position?integer

Range1 <= value

reviewType?string

Value in"mandatory" | "conditional"

reviewerId?string

Format: uuid

rules?array<SimpleReviewRuleRequest\>

\[key: string\]?never

Response Body

200

application/json

409

application/json

curl -X PATCH "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c/review-stages/4f7b91f7-bf39-43fd-8f28-54d2be41c5ef" \  -H "Content-Type: application/json" \  -d '{}'

200409

{
  "id": "string",
  "name": "Manager Approval",
  "reviewerInstructions": "string",
  "position": 1,
  "reviewType": "mandatory",
  "reviewer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Jane Reviewer",
    "email": "contact@parser.example"
  },
  "rules": [
    {
      "id": "string",
      "type": "simple",
      "field": "Total Amount",
      "condition": "extracted_value",
      "operator": "equals",
      "value": "string",
      "name": "string",
      "editable": true
    }
  ]
}

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