E-File Magic

Imports

Start an import

Process a configured spreadsheet for its authorized destination filer.

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

Request fields

3 fields
submission_idRequiredstring (uuid)

Import submission ID returned when the import was created.

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: ApiV1ImportStartRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/imports/submissions/start' \
  --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.