OmnioDocsAPI referenceOpen the app

Create import

POST/v1/imports

Import contacts from a CSV or JSON file (multipart, field file) or a JSON body {contacts}, with mapping_id, mapping or template.

The worker applies it.

Scope imports:writeIdempotency-Key optional

Request body

A CSV or JSON file as multipart field file, or a JSON body with contacts. Name the columns with mapping_id, mapping or template.

Response

  • 202Success
Response fields
import_idstringRequired
statusstringRequired
sourcestringRequired
mapping_idstringRequired
May be null
total_countintegerRequired
created_countintegerRequired
updated_countintegerRequired
rejected_countintegerRequired
processed_countintegerRequired
error_codestringRequired
May be null
created_atstringRequired
started_atstringRequired
May be null
finished_atstringRequired
May be null

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 403forbidden, or insufficient_scope
  • 404not_found. the saved mapping
  • 409idempotency_conflict
  • 413file_too_large, or file_invalid with too_many_rows
  • 415unsupported_media_type
  • 422validation_error, file_invalid or mapping_invalid
  • 503unavailable. file storage is not configured

Every error has the same shape. See Errors.