Skip to main content
POST
/
v1
/
imports
Request Data Import
curl --request POST \
  --url https://{environment}.userpilot.io/v1/imports \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "end_time": "<string>",
  "file_size": "<string>",
  "filename": "<string>",
  "job_id": "<string>",
  "links": "<string>",
  "start_time": "<string>",
  "total_rows": "<string>"
}

Headers

ā€‹
Content-Type
string
default:multipart/form-data
ā€‹
Accept
string
default:application/json
ā€‹
Authorization
string
default:Token ABC_1234_EFGH_5678
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Body

multipart/form-data
ā€‹
file
file
required

CSV/NDJSON file containing user or company data to import

Response

CSV - OK - Import job successfully created

ā€‹
end_time
string
ā€‹
file_size
string
ā€‹
filename
string
ā€‹
job_id
string
ā€‹
links
string
ā€‹
start_time
string
ā€‹
status
enum<string>
Available options:
queued,
validating,
processing,
pending_refresh,
completed,
failed
ā€‹
total_rows
string