Import / Export API · imports

Set which CSV column feeds which target field

PUT /imports/{jobId}/mapping

Appends import.mapped. Rejected with 422 InvalidMapping if a field is unknown, two columns claim the same field, or a required field is unmapped; 409 ImportNotReady once the job is committed (queued), running or finished. Idempotent by content: re-mapping a staged job replaces the mapping whole, so a retry lands on the same mapping.

Access

Requires imports:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: re-mapping a staged job replaces the mapping whole, so a retry lands on the same mapping.

Why every write carries a key: Idempotency and retries.

Facts appended

  • import.mapped

What a fact is: Facts and the journal.

AI agent tool

Agents call this as imports_map_columns (Imports: Map columns), in the imports toolset.

Connecting an agent: AI agents.

Example

curl
curl -X PUT 'https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/mapping' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "hasHeaderRow": true,
  "columns": [
    {
      "column": 0,
      "field": "sku"
    },
    {
      "column": 1,
      "field": "name"
    },
    {
      "column": 2,
      "field": "quantity"
    }
  ]
}'
JavaScript (fetch)
const response = await fetch("https://import.getmanifold.io/imports/imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80/mapping", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "hasHeaderRow": true,
    "columns": [
      {
        "column": 0,
        "field": "sku"
      },
      {
        "column": 1,
        "field": "name"
      },
      {
        "column": 2,
        "field": "quantity"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "hasHeaderRow": true,
  "columns": [
    {
      "column": 0,
      "field": "sku"
    },
    {
      "column": 1,
      "field": "name"
    },
    {
      "column": 2,
      "field": "quantity"
    }
  ]
}
Response · 200 · application/json
{
  "id": "imp_01a15890-2c00-7a11-8b22-3c4d5e6f7a80",
  "target": "inventory.item",
  "filename": "opening-stock.csv",
  "status": "mapped",
  "headers": [
    "SKU",
    "Product name",
    "Qty"
  ],
  "progress": {
    "rows": 4,
    "applied": 0,
    "failed": 0,
    "skipped": 0
  },
  "createdAt": "2026-10-20T06:00:00.000Z",
  "updatedAt": "2026-10-20T06:01:10.000Z",
  "mapping": {
    "hasHeaderRow": true,
    "columns": [
      {
        "column": 0,
        "field": "sku"
      },
      {
        "column": 1,
        "field": "name"
      },
      {
        "column": 2,
        "field": "quantity"
      }
    ]
  }
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: import-export.openapi.json. Base URL https://import.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

404

RefusalWhat it meansWhat to do
ImportJobNotFound jobId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
ImportNotReady jobId, status, expected The import is not in a state this call accepts.Read the record: its status says where it stands, and expected the states this call accepts.
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

422

RefusalWhat it meansWhat to do
InvalidMapping reason, field The column mapping does not fit the target. field names the problem.Map every required field once.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in