Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
migrations

Run Migration From Csv

Run a migration script for multiple clients specified in a CSV file.

Args: csv_file: CSV file containing client IDs script_identifier: The migration script to run client_id_column: Name of the column containing client IDs (default: "client_id") background_tasks: Background task handler client_service: ClientService instance

Returns: CSVMigrationResponse with processing results

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

Query parameters

script_identifierstring required
client_id_columnstring
send_email_summaryboolean
email_recipientsstring nullable

Headers

X-Confirm-Destructivestring nullable

Response

Successful Response

messagestring required
script_identifierstring required
statusstring required
total_clientsinteger required
processed_clientsinteger
successful_migrationsinteger
failed_migrationsinteger
skipped_migrationsinteger
errorsstring[]
email_sentboolean
email_recipientsstring[] nullable