Admin APIs
migrations

Run Migration From Csv Async

Changed on

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

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/migrations/run-csv-async
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

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

Changes

  • d1966b531e25Revision changes
    • breaking

      the request property became required

    • info

      the request property default value add_wallets was removed