Start import

post

https://api.bloomreach.com/data/v2/workspaces/{workspaceId}/imports/{import_id}/start

Trigger the run of an existing workspace-scoped import programmatically.

The following types of imports can be triggered: URL, File storage
(GCS, S3, SFTP), Data warehouse.

If you're using a URL or File storage (GCS, SFTP) import, you can
override its original path or URL. When overridden, the path
applies only to this specific run and does not modify the import
definition.

Use this endpoint with a workspace API key (issued in
Workspace settings → Access management → API). The
{workspaceId} in the path must match the workspace the API key
was issued for.

Authorization

Access type: Private access (workspace API key)
Permission required: Imports → Allow trigger imports

Limitations

Cannot trigger Copy & paste or File upload imports.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceId

string

required

The ID of your Bloomreach Engagement workspace. Must match the
workspace the API key was issued for; otherwise the request is
rejected with HTTP 403.

import_id

string

required

The ID of an existing import in the workspace.

Body Params

Optional body to override the source path or skip the
connection-test step. The body may be omitted entirely.

path

string

URL, GCS, or SFTP path that overrides the import's configured
source. The override applies only to this run — it does not
modify the import definition. Only applicable for URL and
Filestorage (GCS, SFTP) imports.

test_connection

boolean

Defaults to true

When true (default), the API tests the import-source
connection before starting the run. Set to false to skip
the check — useful for sources that may otherwise time out.
With the check skipped, the import can still fail later if
the source is unreachable.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Import triggered successfully.

400Bad request — the request was malformed, contained invalid parameters, or the underlying import service rejected the run (for example, an invalid override path).

401Authentication is missing or invalid. Provide HTTP Basic credentials with a valid API Key ID and Secret.

403The API key lacks the Imports → Allow trigger imports permission, or the workspaceId in the path does not match the workspace the API key was issued for.

404No import with the given import_id exists in the addressed workspace.