Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
migrations

Run Migration From Csv Sync

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

Args: request: CSVFilePathMigrationRequest containing all parameters client_service: ClientService instance

Returns: CSVMigrationResponse with processing results

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

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

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