VEvern-so
Migrations

Create a migration

Changed on

Create a migration workspace for one customer — a workbook with one sheet per template. Requires API-key auth specifically. external_id makes creation idempotent: re-sending the same one (with the same source) returns the existing migration with a 200.

post/migrations

Request

Request body

namestring required

Display name for the migration (e.g. the customer's org name).

sourcestring

The source name this migration comes from. Optional — omit for a sourceless migration.

external_idstring

Your own identifier for this customer. Alphanumeric, hyphens, underscores. Makes creation idempotent.

templatesstring[]

Template slugs to create sheets from. Omit to use every active template.

Response

The created migration (200 when an existing migration is returned via external_id idempotency).

Changes