Start CSV import of contacts

POST

/contacts/imports

• Production

Enqueues a CSV import job. sourcePath must be an opaque upload path returned by POST /jobs/uploads.

Authorizations

• bearerAuth
  contacts:write jobs:write

Parameters

Header Parameters

Idempotency-Key

string

Request Body

object

sourcePath

required

string

mapping

required

object

key

additional properties

string

updateInPlace

boolean

Responses

202

Job enqueued

object

data

required

object

job_id

required

string

status_url

required

string

meta

required

object

request_id

Server-generated request identifier

string

pagination

object

cursor

required

Opaque cursor for the next page; null when no more results

string | null

has_more

required

Whether more pages are available after this one

boolean

count

required

Items in this page

integer

403

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string

422

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string