Commit Import

Import the uploaded rows with this mapping. 409 if the import was already committed. Returns a result per row (created / updated / skipped / error, with a reason) and the summary counts. Rows matching the suppression list are imported but reported in `suppressed` (they stay uncontactable), unless `skip_suppressed` is set. With `enrich: true` and `ENRICHMENT_ASYNC=true` (off by default) the leads the import creates or updates (not suppressed ones, at most 100 per import) are also queued for enrichment as background jobs; `options.enrich` is then `true`. Otherwise the flag is ignored. With `IMPORTS_ASYNC_MIN_ROWS` set (off by default), a file with at least that many data rows is imported by a background job instead: the response is 202 with the same body, `summary.status` `processing` and empty `results`. Poll `GET /imports/{import_id}` until it is `completed` (or `failed`): it then has the counts and the skipped or failed rows (`errors`).

API key access

Needs the leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/imports/{import_id}/commit

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

import_idstring

Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

mappingarray<ColumnMappingIn>

Items1 <= items <= 200

dedupe?DedupeStrategy

Default"skip"

default_country?string | null

ISO alpha-2 for phone numbers without a country code (default: workspace)

Length2 <= length <= 2

skip_suppressed?boolean

Skip rows on the suppression list instead of importing them as suppressed

Defaultfalse

enrich?boolean

Queue enrichment for the imported leads (default false; only with ENRICHMENT_ASYNC=true and a provider configured; at most 100 leads per import, suppressed ones skipped). Ignored otherwise.

research?boolean

Queue AI research for the imported leads (default false; only with RESEARCH_ASYNC=true and the AI service configured; at most 25 leads per import, suppressed ones skipped; a company's website and news are reused for its other leads). Ignored otherwise.

Response Body

curl -X POST "http://localhost:8000/api/v1/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/commit" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "mapping": [
      {
        "column": 0,
        "field": {}
      }
    ]
  }'

curl -X POST "http://localhost:8000/api/v1/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/commit" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "mapping": [      {        "column": 0,        "field": {}      }    ]  }'

{
  "summary": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "filename": "string",
    "status": "previewed",
    "encoding": "string",
    "delimiter": "string",
    "headers": [
      "string"
    ],
    "total_rows": 0,
    "created_count": 0,
    "updated_count": 0,
    "skipped_count": 0,
    "error_count": 0,
    "suppressed_count": 0,
    "mapping": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "options": {
      "property1": null,
      "property2": null
    },
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  },
  "results": [
    {
      "row": 0,
      "status": "created",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "reason": "string",
      "message": "string",
      "suppressed": [
        "string"
      ]
    }
  ]
}

{
  "summary": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "filename": "string",
    "status": "previewed",
    "encoding": "string",
    "delimiter": "string",
    "headers": [
      "string"
    ],
    "total_rows": 0,
    "created_count": 0,
    "updated_count": 0,
    "skipped_count": 0,
    "error_count": 0,
    "suppressed_count": 0,
    "mapping": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "options": {
      "property1": null,
      "property2": null
    },
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "created_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  },
  "results": [
    {
      "row": 0,
      "status": "created",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "reason": "string",
      "message": "string",
      "suppressed": [
        "string"
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200

202

422