Skip to main content
POST
Start an import

Authorizations

Authorization
string
header
required

An organization's API key, sent on every call as Authorization: Bearer <key>. A person of the organization creates it in the app, in Settings › API and connections › API keys.

Path Parameters

orgId
string<uuid>
required

Body

application/json
entity
string
required
fileId
string<uuid>
required
hasHeader
boolean
required
mode
enum<string>
required
Available options:
create,
update,
clean,
delete
Example:

"create"

mapping
object
required
matchBy
object[]
required
Required array length: 1 - 10 elements
options
object
required
worksheet
string
Minimum string length: 1
cleanFields
string[]
Minimum array length: 1

Response

Accepted: the job started. Follow it by its jobId.

jobId
string<uuid>
required