Bulk Import

post https://api.g001.enterprise.ipost.com/v1/{ClientToken}/bulkimport

Import a file

Path Params

ClientToken

string

required

Client-specific Identification String

Body Params

FileLocation

string

required

The URL where the file to be imported is. It supports any of these: [HTTP][HTTPS][FTP][FTPS][SFTP]. Only alphanumeric characters, spaces, dashes ("-") and underscores ("_") are allowed.

FileType

string

required

The type of the file.

FileDestinationObjType

string

required

Allowed values: "list" or "cdt". At the moment only Static Lists and Custom Data Tables are allowed.

FileDestinationLabel

string

required

The name of the target List or Data Table.

Configuration

string

required

Allowed values for CDTs: "add-only", "update-only", "add-update" or "overwrite". Allowed Values for Lists: "add-update", "overwrite".

ConfirmationEmail

string

ConfirmationURL

string

ColumnMapping

array of strings

required

For each field in the target List, indicate whether to "ignore" it for this import or indicate the name of the file column to import data from.

ColumnMapping*

IncludeColumnHeaders

boolean

Pass "true" if the file to import has a header on the first row.

SkipRows

boolean

Passing "true" will skip invalid rows and continue importing the following ones. A value of "false" will stop the import at the first error encounter.

DoubleQuotes

boolean

Indicate whether or not to respect double quotes as a text qualifier

Separator

string

required

One between "," (comma) and "\t" (tab).

ReportEmail

string

required

Headers

X-Auth-Token

string

required

Auth_token

Response

Language

Request


xxxxxxxxxx
20
1
{
2
  "FileLocation": "ftp://username:password@hostname:port/filelocation",
3
  "FileType": "csv",
4
  "FileDestinationObjType": "list",
5
  "FileDestinationLabel": "List_for_bulk_import",
6
  "Configuration": "overwrite",
7
  "ConfirmationEmail": "test@example.com",
8
  "ConfirmationURL": "",
9
  "ColumnMapping": [
10
    "ignore",
11
    "email_address",
12
    "ignore",
13
    "ignore"
14
  ],
15
  "IncludeColumnHeaders": true,
16
  "SkipRows": true,
17
  "DoubleQuotes": false,
18
  "Separator": ",",
19
  "ReportEmail": "test@example.com"
20
 }

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200