prospects

While importing prospect you will receive the requestId. Using that requestId you can check the status of the import process.

While importing prospect using v1/prospects/import-with-field-name and v1/sequences/prospects/import-with-field-name, you will receive the requestId.

Using that requestId, you can check the status of the import process. If there is any error during the import process, you will receive a CSV file link containing the error details.

get/v1/prospects/import-status/{requestId}

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/prospects/import-status/:requestId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

requestIdstring required

Response

Retrieve the prospect import status of requestId

isCompletedboolean required

Indicates whether the import process is completed successfully.

reportURLstring

URL to download additional information related to the import process, such as error reports for failed prospects or other details.

Example response

{
  "isCompleted": true,
  "reportURL": "https://example.com/import-prospect/file?fileName=import+error+report.csv&key=failedProspect%2F95689%2F158b2ab10e4%2Fimport_err.csv"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.