Skip to main content
POST
Preview an import

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

sessionId
string<uuid>
required

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
string<uuid>
required

Import session ID.

headers
string[]
required

Column headers detected in the CSV.

proposed_mappings
object[]
required

Proposed column-to-field mappings, one per header. Use these as the starting point for the execute call's mappings.

unmapped_headers
string[]
required

Headers with no proposed target (target_field: null).

available_fields
object
required

Catalog of valid mapping targets.

field_creation_candidates
object[]
required

Suggested new custom fields for unmapped columns.

sample_rows
object[]
required

A sample of the file's first data rows.

sample_issues
object[]
required

Validation issues found in the sample rows under the proposed mappings — a preview of the problems the full import would hit.

blocking_issues
object[]
required

Issues that must be resolved before execution — currently only missing_identity_mapping: no column maps to email or phone, so contacts cannot be identified.