Skip to main content
POST
Import a CSV

Authorizations

Authorization
string
header
required

Secret API key, created in the dashboard under Settings → API. Send it as Authorization: Bearer rk_secret_… from your server only. Publishable keys (pk_live_…) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.

Path Parameters

slug
string
required

Template slug — lowercase [a-z0-9-].

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"warehouse-intake"

Body

application/json
csv
string
required

Raw CSV text, header row first.

Minimum string length: 1
column_mapping
object

Optional explicit header→field mapping when automap falls short.

Response

Identical bytes already submitted — the EXISTING job is returned with duplicate: true; nothing re-runs.

id
string
required
template_slug
string
required
status
enum<string>
required
Available options:
processing,
completed,
failed,
aborted
total_rows
integer
required
imported_rows
integer
required
invalid_rows
object[]
required
requested_at
string<date-time>
required
duplicate
enum<boolean>
required
Available options:
true
completed_at
string<date-time>
failure_reason
string