Upload an import file

POST 
/objects/:object_id/imports

Upload a CSV or XLSX (multipart/form-data with a file part) and get an import job at its mapping stage: the file's headers, a five-row preview and a suggested_mapping matched by header name.

Three steps, like the console:

1. Upload (this call).
2. Dry run — POST …/imports/{job_id}/dry-run with the mapping you want. Poll GET …/imports/{job_id} until status is ready; dry_run holds the create / update counts and errors the first row problems.
3. Confirm — POST …/imports/{job_id}/confirm. Poll until completed; error_report_url lists every row that was skipped.

Needs this credential to be allowed to create records of the object (and to update them, when the mapping names an upsert_field_id). Customers and the records of your own objects count against the plan's limits.

Request

Responses

201

The import job, at its mapping stage.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

400

The request was malformed, or a parameter was rejected.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

401

No token, an expired token, or a credential that has been revoked.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

403

Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.

404

No such resource in this account.

Response Headers

X-Request-Id

Correlation id for this request. Quote it when reporting a problem.