Skip to main content
POST
/
lists
/
{listId}
/
import-jobs
Create import job
curl --request POST \
  --url https://inboxapp.com/api/v1/lists/{listId}/import-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "<unknown>",
    "content": "<string>",
    "fileName": "<string>",
    "columnMapping": [
      {
        "csvHeader": "<string>",
        "targetColumnId": "<string>"
      }
    ],
    "mergeStrategy": "overwrite"
  }
}
'
{
  "id": "<string>",
  "type": "<string>",
  "status": "queued",
  "totalCount": 1500,
  "processedCount": 0,
  "addedCount": 0,
  "skippedCount": 0,
  "failedCount": 0,
  "error": "Rate limit exceeded",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2025-01-16T08:00:00.000Z",
  "completedAt": "2025-01-16T08:05:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.inboxapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
listId
string
required

The ID of the list to import leads into.

Pattern: ^[0-9a-z]+$

Body

application/json
​
data
CSV file import · object
required

Import configuration. The type field determines which import source is used and what additional fields are required.

Response

200 - application/json

OK

​
id
string
required

Unique identifier for the import job.

Pattern: ^[0-9a-z]+$
Example:

"l44e15irdq4db30i77cgphhx"

​
type
string
required

The type of importer used for this job.

Examples:

"csv"

"followers"

"likes"

​
status
enum<string>
required

Current status of the import job. 'queued' means the job is waiting for a slot. 'starting' means a slot has been acquired and execution is about to begin.

Available options:
queued,
starting,
running,
paused,
completed,
failed,
canceled
Examples:

"running"

"completed"

​
totalCount
integer | null
required

Total number of items to import, if known.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1500

​
processedCount
integer
required

Number of items processed so far.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

750

​
addedCount
integer
required

Number of leads successfully added.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

700

​
skippedCount
integer
required

Number of leads skipped (already exist).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

45

​
failedCount
integer
required

Number of leads that failed to import.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

5

​
error
string | null
required

Error message if the job failed.

Example:

"Rate limit exceeded"

​
createdAt
string<date-time>
required

When the import job was created.

Example:

"2025-01-15T10:30:00.000Z"

​
updatedAt
string<date-time> | null
required

When the import job was last updated.

Example:

"2025-01-16T08:00:00.000Z"

​
completedAt
string<date-time> | null
required

When the import job completed.

Example:

"2025-01-16T08:05:00.000Z"