prospects

To import new prospects

Changed on
post/v1/prospects/import

Request

Request body

prospectListobject required

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

stepIdnumber

Optional. 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

Response

<b><i> Prospect Import Status Codes : </i></b><br><br>

  • <b>Status:</b> 10000   <b>Description:</b> Success
  • <b>Status:</b> 10100   <b>Description:</b> Invalid Email
  • <b>Status:</b> 10200   <b>Description:</b> Prospect already present in another step of same sequence
  • <b>Status:</b> 10300   <b>Description:</b> Mismatch in custom field type
  • <b>Status:</b> 10400   <b>Description:</b> Nothing to update
  • <b>Status:</b> 10500   <b>Description:</b> Nothing to overwrite
  • <b>Status:</b> 10600   <b>Description:</b> Duplicate prospect
  • <b>Status:</b> 10700   <b>Description:</b> Bounced prospect
  • <b>Status:</b> 10800   <b>Description:</b> Unsubscribed prospect
  • <b>Status:</b> 10900   <b>Description:</b> More then One Separator
  • <b>Status:</b> 11000   <b>Description:</b> Prospect already present with different owner
  • <b>Status:</b> 12000   <b>Description:</b> Prospect is active in another sequence
unknown required

Example response

{
  "message": "Prospects have been imported",
  "payload": [
    {
      "email": "vishwash1245@gmail.com",
      "status": 10200
    },
    {
      "email": "saleshandyUser123@gmail.com",
      "status": 10200
    }
  ]
}

Changes