POST
/
headless
/
imports
/
Create a new headless import
curl --request POST \
  --url https://app.dromo.io/api/v1/headless/imports/ \
  --header 'Content-Type: application/json' \
  --header 'X-Dromo-License-Key: <api-key>' \
  --data '{
  "schema_id": "94187d21-9820-420f-b08c-a80cbbf52604",
  "original_filename": "user.csv",
  "initial_data": [
    {
      "name": "Jeff",
      "email": "jeff@dromo.io"
    },
    {
      "name": "Sarah",
      "email": "sarah@dromo.io"
    }
  ],
  "import_metadata": {
    "user": {
      "id": "jeff_id",
      "name": "Jeff",
      "email": "jeff@dromo.io",
      "companyName": "Dromo",
      "companyId": "dromo_id"
    }
  }
}'
{
  "id": "94187d21-9820-420f-b08c-a80cbbf52604",
  "schema_id": "94187d21-9820-420f-b08c-a80cbbf52604",
  "status": "AWAITING_UPLOAD",
  "original_filename": "user_data.csv",
  "created_date": "2023-11-07T05:31:56Z",
  "modified_date": "2023-11-07T05:31:56Z",
  "upload": "https://dromo-headless-imports-prod.s3.us-west-2.amazonaws.com/test-key-123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARY5HJCMTO2AUIBEU%2F20230227%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230227T160315Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=0998ccd9c93142498784d1046bc2709612430f6a0a573572f743e16896d4c498",
  "review_url": "https://app.dromo.io/headless/94187d21-9820-420f-b08c-a80cbbf52604/",
  "result_metadata": null,
  "import_errors": null
}

Authorizations

​
X-Dromo-License-Key
string
header
required

This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.

Body

application/json
​
schema_id
string
Example:

"94187d21-9820-420f-b08c-a80cbbf52604"

​
original_filename
string | null

Name of the file being imported (exclude if using initial_data)

Example:

"user.csv"

​
initial_data
any[] | null

Complete JSON data to be imported, max size 15MB (exclude if using a file)

Example:
[
  { "name": "Jeff", "email": "jeff@dromo.io" },
  {
    "name": "Sarah",
    "email": "sarah@dromo.io"
  }
]
​
import_metadata
object | null
Example:
{
  "user": {
    "id": "jeff_id",
    "name": "Jeff",
    "email": "jeff@dromo.io",
    "companyName": "Dromo",
    "companyId": "dromo_id"
  }
}

Response

Import successfully initialized

​
id
string
Example:

"94187d21-9820-420f-b08c-a80cbbf52604"

​
schema_id
string
Example:

"94187d21-9820-420f-b08c-a80cbbf52604"

​
status
enum<string>
Available options:
AWAITING_UPLOAD,
RUNNING,
SUCCESSFUL,
FAILED,
NEEDS_REVIEW
Example:

"AWAITING_UPLOAD"

​
original_filename
string
Example:

"user_data.csv"

​
created_date
string<date-time>
​
modified_date
string<date-time>
​
upload
string
Example:

"https://dromo-headless-imports-prod.s3.us-west-2.amazonaws.com/test-key-123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARY5HJCMTO2AUIBEU%2F20230227%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230227T160315Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=0998ccd9c93142498784d1046bc2709612430f6a0a573572f743e16896d4c498"

​
review_url
string
Example:

"https://app.dromo.io/headless/94187d21-9820-420f-b08c-a80cbbf52604/"

​
result_metadata
object | null
Example:

null

​
import_errors
object[] | null
Example:

null