Import / Export API · mappings
Save a column mapping for reuse on the next file of the same shape
POST /mappings
Validated against the target exactly as PUT /imports/:jobId/mapping is, so a saved mapping can never be one that would be refused later. Appends import.mapping-saved. Idempotent by content — on (name, target): saving the same mapping again returns it and appends nothing.
Access
Requires imports:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by content — on (name, target): saving the same mapping again returns it and appends nothing.
Why every write carries a key: Idempotency and retries.
Facts appended
import.mapping-saved
What a fact is: Facts and the journal.
AI agent tool
Agents call this as imports_save_mapping (Imports: Save mapping), in the imports toolset.
Connecting an agent: AI agents.
Example
curl -X POST 'https://import.getmanifold.io/mappings' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"name": "Opening stock sheet",
"target": "inventory.item",
"mapping": {
"hasHeaderRow": true,
"columns": [
{
"column": 0,
"field": "sku"
},
{
"column": 1,
"field": "name"
},
{
"column": 2,
"field": "quantity"
}
]
}
}'const response = await fetch("https://import.getmanifold.io/mappings", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"name": "Opening stock sheet",
"target": "inventory.item",
"mapping": {
"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();{
"name": "Opening stock sheet",
"target": "inventory.item",
"mapping": {
"hasHeaderRow": true,
"columns": [
{
"column": 0,
"field": "sku"
},
{
"column": 1,
"field": "name"
},
{
"column": 2,
"field": "quantity"
}
]
}
}{
"id": "map_01a15890-3e80-7c31-8d42-5e6f7a8b9ca2",
"name": "Opening stock sheet",
"target": "inventory.item",
"mapping": {
"hasHeaderRow": true,
"columns": [
{
"column": 0,
"field": "sku"
},
{
"column": 1,
"field": "name"
},
{
"column": 2,
"field": "quantity"
}
]
},
"createdAt": "2026-10-20T06:02:00.000Z"
}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
| Refusal | What it means | What 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
| Refusal | What it means | What to do |
|---|---|---|
SubscriptionRequired status | The organization's subscription has lapsed, so writes are refused. | An owner settles billing. Reads still work meanwhile. |
403
| Refusal | What it means | What 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. |
409
| Refusal | What it means | What to do |
|---|---|---|
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
| Refusal | What it means | What to do |
|---|---|---|
InvalidMapping reason, field | The column mapping does not fit the target. field names the problem. | Map every required field once. |
503
| Refusal | What it means | What 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.