E-File Magic

Imports

Map import columns

Match the uploaded file's columns to E-File Magic fields.

POST
/api/v1/imports/submissions/configure_mapping
Authentication
OAuth 2.0 access token
Required scopes
imports.write
Idempotency key
Required
Rate-limit cost
5 units

Request fields

7 fields
mappingRequiredobject

Source-column mappings for the import. Expand the nested fields for the mapping structure.

submission_idRequiredstring (uuid)

Import submission ID returned when the import was created.

default_form_idOptionalstring | null

Form used for imported rows that do not select one explicitly. Maximum characters: 64.

default_schema_revOptionalinteger | null

Schema revision used for rows that do not select one explicitly. Minimum: 1.

default_tax_yearOptionalinteger | null

Tax year used for rows that do not select one explicitly. Allowed values: 2022, 2023, 2024, 2025, 2026.

expected_versionOptionalinteger | null

Version from the latest read of the record. A changed version requires review before updating. Minimum: 1.

target_filer_idOptionalstring (uuid) | null

Filer that will receive the imported records; your connection must be allowed to use it.

Headers (3)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
Idempotency-KeyRequired
Opaque caller-generated key bound to resolved tenant, connection, and actor scope.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.

Complete request schema: ApiV1ImportConfigureMappingRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/imports/submissions/configure_mapping' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Idempotency-Key: <unique-operation-key>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace placeholders with your own values. Use the API resource origin provided for your environment.

Create request.json using the documented fields. Field descriptions are not sample values.

Retrying a request? Keep the same idempotency key and body after an uncertain result. A different key can repeat the action.