Common models

The following is an example of a completed Bulk Import Job:

{
  "id": 75,
  "status": "Completed",
  "resourceType": "Contacts",
  "resultFileSizeLimitKb": 5000,
  "errors": [],
  "resultFiles": [
    {
      "url": "https://somedomain.com/filename.csv",
      "dateExpired": "2019-05-15T08:45:50.2062048-04:00"
    }
  ]
}

Property

Type

Description

id

int

Unique identifier for a Bulk Import Job

status

string

The status of the Bulk Import Job; may be Pending, InProgress, InProgressWithErrors, Completed, CompletedWithErrors, or Failed

resourceType

string

One of the available resourceType options from the GET /bulkImportJobs/resources endpoint.

resultFileSizeLimitKb

string

The maximum size in Kb (between 5000 and 100000) of any resulting .csv file.

errors

string

A collection of error objects, as described below.

resultFiles

string

A collection of file objects in the format [ { url, dateExpired } ]. These are only included if the job status is Completed or CompletedWithError. File access expires after 24 hours.

An error object can have multiple properties to help debug a failed bulkImportJob.

Property

Type

Description

referenceCode

string

A reference for any error which occurred during the processing of the Import Job. We may ask for this code if we are helping you debug errors. Will be null unless status is Error.

text

string

A descriptive error string for an error which occurred during the processing of the Import Job. Will be null unless status is Error.

code

string

A static string corresponding to the code, which can be used for automated error handling. Will be null unless status is Error.