Create an import mapping profile
Platform module
POST/import-mapping-profilesimportMappingProfiles.create
A saved column-to-field mapping for one-click repeat imports. Creates an import mapping profile. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability data.classification.write.
- OAuth scopes: data.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ImportMappingProfileCreate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Profile name.Constraints: length 1 to 300 |
| target_code | string | Yes | Import target the profile maps onto.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"name": "Vendor List From Accounting",
"target_code": "vendors"
}Response 201: ImportMappingProfile
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import mapping profile. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Profile name.Constraints: length 1 to 300 |
| target_code | string | Yes | Import target the profile maps onto.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Vendor List From Accounting",
"target_code": "vendors"
}Code samples
curl -X POST "$XOS_BASE_URL/import-mapping-profiles" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Vendor List From Accounting","target_code":"vendors"}'const { data } = await xos.importMappingProfiles.create({
"name": "Vendor List From Accounting",
"target_code": "vendors"
});response = xos.import_mapping_profiles.create({"name": "Vendor List From Accounting", "target_code": "vendors"})xos import-mapping-profiles create --data '{"name":"Vendor List From Accounting","target_code":"vendors"}'