---
title: "Start an import"
method: POST
path: "/leads/imports/{id}/start"
tags: ["Leads"]
---

# Start an import

`POST /leads/imports/{id}/start`

## Request

- Base URL: `https://api.surense.com/api/v1`
- URL: `https://api.surense.com/api/v1/leads/imports/{id}/start`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.surense.com/oauth/token`

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- ImportRecordValue
  - `id` string, uuid
  - `tenantId` string, uuid
  - `agencyId` string, uuid
  - `fileName` string
  - `fileMime` string
  - `fileSize` integer
  - `status` 'INITIATED' | 'UPLOADED' | 'PROCESSING' | 'PROCESSED' | 'FAILED' | 'PARTIAL'
  - `createdDate` string, date-time
  - `createdBy` string, uuid
  - `creatorName` string
  - `lastModifiedDate` string, date-time
  - `lastModifiedBy` string, uuid
  - `version` integer
  - `startedAt` string, date-time
  - `endedAt` string, date-time
  - `errorMessage` string
  - `totalRecords` integer
  - `importedRecords` integer
  - `failedRecords` integer
  - `resultsFileName` string
  - `resultsFileMime` string
  - `downloadExpiresAt` string, date-time
  - `originalDownloadable` boolean
  - `resultsDownloadable` boolean

---

[API](https://skmtc.dev/surense/apis/lead-api.md) - [All operations](https://skmtc.dev/surense/apis/lead-api/llms.txt) - [OpenAPI document](https://skmtc.dev/surense/apis/lead-api/revisions/e766c34d3234?raw)