Preview an import
Parse the session’s CSV and return everything needed to build the mapping step: the detected column headers, proposed column-to-field mappings (deterministic header matching plus AI-assisted suggestions), the catalog of available target fields (importable standard fields and your active custom fields), suggested new custom fields for unmapped columns (field_creation_candidates), a sample of rows, and validation issues found in that sample.
No request body. Safe to call repeatedly — for example, after bulk-creating suggested custom fields via POST /v1/contact-fields, preview again to see the new fields mapped.
blocking_issues must be resolved before executing: an import needs at least one column mapped to email or phone so contacts can be identified and deduplicated.
Authorizations
Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.
Path Parameters
Import session ID from POST /v1/contacts/imports.
Response
Parsed preview with proposed mappings and sample validation issues.
Preview of an import: detected headers, proposed mappings, available target fields, new-field suggestions, and sample validation issues.
Import session ID.
Column headers detected in the CSV.
Proposed column-to-field mappings, one per header. Use these as the starting point for the execute call's mappings.
Headers with no proposed target (target_field: null).
Catalog of valid mapping targets.
Suggested new custom fields for unmapped columns.
A sample of the file's first data rows.
Validation issues found in the sample rows under the proposed mappings — a preview of the problems the full import would hit.
Issues that must be resolved before execution — currently only missing_identity_mapping: no column maps to email or phone, so contacts cannot be identified.