SimplyParseDocs

Correct parsed values

Write reviewed or corrected values back to an entry so SimplyParse and your exports stay in sync.

PUT/dapi/v1/parser/{slug}/parsed-data/{entry_id}

Overwrites top-level values on one entry.

When a person reviews an entry in your system and fixes a value, send the correction back. The dashboard then shows the corrected data (with the field marked as edited), and later Excel exports include it.

Request

Send JSON with an update_fields object of field names and new values:

curl -X PUT "https://api.simplyparse.com/dapi/v1/parser/$PARSER_SLUG/parsed-data/$ENTRY_ID" \
  -H "Authorization: Token $SIMPLYPARSE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"update_fields": {"invoice_number": "INV-20418-A", "total_amount": 48520}}'

The response contains the entry with its updated parsed_data.

Which ID to use

The path takes the entry ID. Depending on where your data came from, that's:

Rules

  • Top-level fields only. Keys must be your parser's top-level field names. Object and list values, such as line_items, are skipped.
  • Unknown keys are ignored. A misspelled field name is silently skipped, so compare the returned parsed_data with what you sent.
  • Validation isn't re-run. is_valid and validation_errors keep the values from processing. Record the review outcome in your own system.
  • No webhook is sent for a correction.

Errors

codeCause
entry_not_foundThe entry ID doesn't exist for this parser slug.
no_fields_providedupdate_fields was missing or empty.

On this page