Skip to main content
POST
Commit an import into a list

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

importId
string
required

The importId returned by POST /business/imports (or /business/imports/presign) that identifies the uploaded file.

Required string length: 8 - 800

Body

application/json
listId
string

24-character hex id of an existing contact list to append the rows to; mutually exclusive with listName, and an unknown or non-owned id answers 404 LIST_NOT_FOUND.

listName
string

Name of the destination contact list (1-255 characters): an existing list with this exact name (case-insensitive) is reused, otherwise it is created; mutually exclusive with listId. Two lists sharing the name answer 409 LIST_NAME_AMBIGUOUS and reserved system titles answer 422 LIST_NAME_RESERVED.

Required string length: 1 - 255
mapping
object

Column mapping from source column header to target field, e.g. {"fname": "First Name"} (up to 200 entries). Each key is a column header spelled exactly as it appears in the file (the headers of the import preview). Each value is one of exactly these 21 target labels, spelled and cased exactly like this: Full Name, First Name, Last Name, LinkedIn URL, Company, Company Domain, Job Title, Job Level, Department, Industry, Country, State, City, Email, Phone — plus six aliases, each read only when the label it follows is missing or empty: Company Name (after Company), Mobile Phone (after Phone), Seniority then Level (after Job Level), and linkedinUrl then linkedin (after LinkedIn URL). Map to the primary label where you can. A label outside those 21 is ACCEPTED and then silently drops that column — no error, no custom column. Headers that already match a label case-insensitively (email, first_name, title, domain) need no entry, a header with no target carries null and is ignored — so the suggestedMapping from POST /business/imports can be sent back unchanged — and when two headers name the same target only the last one is used.

enrich
enum<string>

Enrichment to run on the imported rows: none (default, rows saved exactly as uploaded), email, phone or phone_and_email (the enrichment waterfall, billed per contact processed) or demographics (resolve rows to canonical contacts, 2 credits per resolved contact).

Available options:
none,
email,
phone,
phone_and_email,
demographics

Response

Success

import
object
required