DEdefra
Import

Start a bulk file import

Starts a bulk file import process asynchronously. Returns immediately with an import ID once the lock has been acquired. The import continues running in the background.

post/import/start

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/import/start
  • Auth
    API key in header X-API-Key

Query parameters

sourceType'internal' | 'external'

The source type for the import ('internal' or 'external')

Response

Import started successfully

importIdstring uuid
sourceTypestring
messagestring
startedAtstring date-time

Changes

No recorded changes to this operation across all 5 revisions of this API.