SAsaleshandy
sequences

Import prospect with field name in to sequence

Changed on

Ensure that the field names exist in the system. You can import up to 100,000 prospects at a time, with a maximum content size of 90 MB.

This can be a large request and may take some time to complete. But you will get response immediately after the request is submitted.

On request of this API, you will receive a requestId that can be used to check the status of the import process.

To check the status of the import process, you can use the v1/sequences/prospects/import-with-field-name/status API.

If there is any error during the import process, you will receive a CSV file link containing the error details.

post/v1/sequences/prospects/import-with-field-name

Request

Request body

prospectListstring[] required

The array of prospect list. Each prospect is represented by an array of fields.

stepIdnumber required

Set the step to which the prospect is to be added

verifyProspectsboolean

Optional. Set to "true" if prospect's email address should be verified

conflictAction'overwrite' | 'noUpdate' | 'addMissingFields' | 'upsert' required

Conflict action to take if we attempt to add an already existing prospect

KeyValueDescription
overwriteOverwriteUpdates existing fields using data from the CSV. Fields that are currently empty will not be filled in
noUpdateSkip Existing ProspectsKeeps existing prospect field details unchanged and does not apply any updates.
addMissingFieldsAdd Missing FieldsFills in fields that are currently empty using data from the CSV. Existing field data is not changed
upsertUpdate All FieldsUpdates existing fields using data from the CSV and adds any that are missing. A blank cell clears the existing value
tagsstring[]

Array of tags to be assigned to the imported prospects. If the tag does not exist, it will be created.

Example request

{
  "prospectList": [
    {
      "First Name": "Jon",
      "Last Name": "Smith",
      "Email": "johnsmith@example.com",
      "Company": "ABC",
      "Country": "USA",
      "Phone Number": "1234567890",
      "Job Title": "Procurement Manager"
    },
    {
      "First Name": "Jemmy",
      "Last Name": "Lorance",
      "Email": "jemmy@example.com",
      "Company": "ABC",
      "Country": "USA",
      "Phone Number": "1234567891",
      "Job Title": "Procurement Manager"
    }
  ],
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ]
}

Response

unknown required

Example response

{
  "message": "Prospect import has started successfully. Please wait while we import your prospects. You may check the status using this API `v1/prospects/import-status/{{requestId}}`.",
  "payload": {
    "requestId": "129a184"
  }
}

Changes