imports.run

Owner only: import customers (and one service address each) from a CSV with the mapping the owner confirmed. mode all_or_nothing (default) writes nothing if any row fails; per_row writes the good rows and reports the rest. dry_run true checks without writing.

WhoAgents can call this
RESTPOST /v1/imports/run
MCP toolimports_run
Writesyes, send an Idempotency-Key
AreaImports, custom fields, tags and search

When to use it

Owner only: import customers (and one service address each) from a CSV with the mapping the owner confirmed. mode all_or_nothing (default) writes nothing if any row fails; per_row writes the good rows and reports the rest.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
shop_idstring (uuid)yes
csvstringyes
mappingarrayyes
mapping[].columnstringyes
mapping[].fieldstring (one of name, first_name, last_name, is_company, company_name, email, phone, lead_source, tags, notes, external_id, property.line1, property.line2, property.locality, property.region, property.postal_code, property.full_address, billing.line1, billing.line2, billing.locality, billing.region, billing.postal_code, billing.country, skip)yes
modestring (one of all_or_nothing, per_row)no
dry_runbooleanno
sourcestringno
on_matchstring (one of skip, update)no
preview_hashstring (sha256)no

Example

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

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "csv": "...",
  "mapping": [
    {
      "column": "...",
      "field": "name"
    }
  ]
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.