Import Leads

POST /bulk/v1/leads.json

Imports a file containing data records into the target instance.

Operation ID: importLeadUsingPOST
Permissions: Read-Write Lead
Request format: multipart/form-data
Returns: ResponseOfImportLeadResponse

Parameters

Query 4

format string required

Import file format.

Values csv tsv ssv

lookupField string

Field to use for deduplication. Custom fields (string, email, integer), and the following field types are supported: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is email. Note: You can use id for update only operations.

partitionName string

Name of the lead partition to import to.

listId integer (int32)

Id of the static list to import into.

Form 1

file file required

File containing the data records to import.

Responses

200 OK ResponseOfImportLeadResponse

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of ImportLeadResponse required

Array of results for individual records in the operation, may be empty

Model ImportLeadResponse

batchId integer (int32) required

Unique integer id of the import batch

importId string

message string

numOfLeadsProcessed integer (int32) required

Number of rows processed so far

numOfRowsFailed integer (int32)

Number of rows failed so far

numOfRowsWithWarning integer (int32)

Number of rows with a warning so far

status string required

Status of the batch

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "batchId": 123,
      "importId": "123",
      "message": "string",
      "numOfLeadsProcessed": 123,
      "numOfRowsFailed": 123,
      "numOfRowsWithWarning": 123,
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.