Abandon a migration

DELETEhttps://app.speybooks.com/api/v1/migration/{id}

Abandon a migration session, setting its status to abandoned. Only a non-terminal, non-executing migration can be abandoned. Abandoning releases the singleton so a new migration can be created. Note that abandoning does not reverse imports that were already confirmed in earlier steps; their data remains. Returns 422 if the migration is already terminal or currently executing.

Path parameters

idstringrequired

Migration ID (e.g. mig_1). Must not be in a terminal or executing state.

Response

200Migration abandoned. A new migration can now be started.

Show response fields

abandonedboolean

messagestring

migrationIdstring

Error codes

404Migration not found.

422Cannot abandon a completed, already-abandoned, or currently-executing migration.

RequestDELETE/v1/migration/{id}curl

curl -X DELETE https://api.speybooks.com/v1/migration/mig_1 \
  -H "Authorization: Bearer sk_test_..."

Response200

{
  "success": true,
  "data": {
    "abandoned": true,
    "migrationId": "mig_1",
    "message": "Migration abandoned. You can start a new one."
  }
}