---
title: "Propose contact import column mappings"
method: POST
path: "/v1/workspaces/{workspaceId}/contacts/import-mapping"
---

# Propose contact import column mappings

`POST /v1/workspaces/{workspaceId}/contacts/import-mapping`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/import-mapping`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, uuid, required

## Request body

- object
  - `filename` string
  - `columns` object[], required
    - `name` string, required
    - `samples` string[]
    - `filled` integer
    - `rows` integer

## Response `200`

Successful response.

- object
  - `data` object, required
    - `mapping` ContactImportMapping, required
      - `columns` object[], required
        - `column` string, required
        - `target` 'email' | 'display_name' | 'first_name' | 'last_name' | 'locale' | 'time_zone' | 'status' | 'unsubscribed_flag' | 'subscribed_flag' | 'field' | 'ignore', required
        - `field_key` string
        - `field_type` 'text' | 'number' | 'boolean' | 'date' | 'choice' | 'choices'
        - `confidence` number, required
        - `source` 'saved' | 'ai' | 'rules' | 'person', required
        - `alternatives` object[]
          - `target` 'email' | 'display_name' | 'first_name' | 'last_name' | 'locale' | 'time_zone' | 'status' | 'unsubscribed_flag' | 'subscribed_flag' | 'field' | 'ignore', required
          - `field_key` string
          - `probability` number, required
      - `locale_values` object, required
    - `review` object, required
      - `needed` boolean, required
      - `reasons` string[], required
      - `columns` string[], required
    - `source` 'saved' | 'ai' | 'rules', required

## Other responses

- `default`: Request failed.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)