Update Correction
PATCH /api/v1/jobs/{job_id}/corrections/{id}/
Update an existing correction. All fields in the request body are optional — only the provided fields will be updated.
Authentication
Requires an API key with jobs:write scope. Pass via the X-API-Key header.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
job_id | string (UUID) | The ID of the extraction job. |
id | string (UUID) | The ID of the correction to update. |
Request Body
All fields are optional. Only provided fields will be updated.
| Field | Type | Description |
|---|---|---|
correction_type | string | Type of correction: wrong_value, wrong_field, missing_field, or spurious. |
field_path | string | Dot-notation path to the corrected field. |
original_value | string | The original extracted value. |
corrected_value | string | The corrected value. |
notes | string | Optional explanation for the correction. |
{
"corrected_value": "5300.00",
"notes": "Updated after re-checking source document"
}Response
Status: 200 OK
{
"id": "f6a7b8c9-0123-4567-89ab-cdef01234567",
"job_id": "e5f6a7b8-c901-2345-6789-abcdef012345",
"correction_type": "wrong_value",
"field_path": "employees[0].gross_pay",
"original_value": "5000.00",
"corrected_value": "5300.00",
"notes": "Updated after re-checking source document",
"created_at": "2026-03-16T12:00:00Z"
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique identifier for the correction. |
job_id | string (UUID) | The extraction job this correction belongs to. |
correction_type | string | Type of correction applied. |
field_path | string | Dot-notation path to the corrected field. |
original_value | string | The original extracted value. |
corrected_value | string | The corrected value. |
notes | string or null | Optional explanation for the correction. |
created_at | string (ISO 8601) | Timestamp when the correction was created. |
Errors
| Status | Description |
|---|---|
400 | Invalid request body or unknown correction_type. |
401 | Missing or invalid API key. |
403 | API key does not have jobs:write scope. |
404 | Extraction job or correction not found. |
Code Examples
curl -X PATCH https://api.parsifyhq.com/api/v1/jobs/e5f6a7b8-c901-2345-6789-abcdef012345/corrections/f6a7b8c9-0123-4567-89ab-cdef01234567/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"corrected_value": "5300.00",
"notes": "Updated after re-checking source document"
}'