Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
migrations

Run Migration From Csv Async

Run a migration script asynchronously for multiple clients specified in a CSV file path. Returns immediately with a task ID that can be used to check status.

Args: request: CSVFilePathMigrationRequest containing all parameters background_tasks: FastAPI BackgroundTasks for async execution

Returns: AsyncMigrationResponse with task ID and initial status

post/api/v1/admin/migrations/run-csv-async

Headers

X-Confirm-Destructivestring nullable

Request body

csv_file_pathstring required
script_identifierstring required
client_id_columnstring
send_email_summaryboolean
email_recipientsstring[] nullable
parametersobject

Response

Successful Response

task_idstring required
messagestring required
script_identifierstring required
statusstring
csv_file_pathstring required
total_clientsinteger required
submitted_atstring required