imports.historyPreview

Dry run of a history import (kind jobs, quotes, invoices or pricebook). Writes nothing. Returns a suggested mapping, what each record would do (create, update, skip, skip_closed or error) with how its customer matched, and a preview_hash. Show it to the owner; imports.historyRun needs the same hash.

When to use it

Move a shop's customer list in from a CSV, including files exported from Jobber, Housecall Pro and CompanyCam. Ask imports.fields what can be filled, run imports.preview to see how each column maps and what would go wrong, show that to the owner, and only then call imports.run with the mapping they confirmed.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

Example

POST https://doingwork.work/v1/imports/history/preview
content-type: application/json
Idempotency-Key: 3f1c...

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "kind": "jobs",
  "csv": "..."
}

Output

{
  "kind": "...",
  "source": "...",
  "on_match": "...",
  "headers": [
    "..."
  ],
  "mapping": [
    {}
  ],
  "preview_hash": "...",
  "records": 1,
  "create": 1,
  "update": 1,
  "skip": 1,
  "skip_closed": 1,
  "failed": 1,
  "row_errors": [
    {}
  ],
  "items": [
    {}
  ]
}

Errors