Skip to content

Confirm Migration

POST
/integrations/migrations/{migration_id}/confirm

Accept the discovery and START IMPORTING. Records begin landing.

A migration cannot be un-run - only cancelled part-way, leaving whatever already arrived. Read the status first: its warnings are the things discovery could not resolve on its own.

An empty body accepts the discovery as proposed, which is the point of previewing it. Org admin, matching the app.

Authorizations

Parameters

Path Parameters

migration_id
required

Migration id from discovery.

string

Migration id from discovery.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Accept a discovery and START IMPORTING.

This is the irreversible half: records begin landing in graph8 and a migration cannot be un-run, only cancelled part-way.

Both fields are OPTIONAL and omitting them accepts the discovery as proposed - which is the point of previewing it first. Send field_mappings_override to change where a CRM field lands, or selected_list_ids to import only some lists.

object
field_mappings_override
Any of:
object
key
additional properties
Array<object>
object
key
additional properties
any
selected_list_ids
Any of:
Array<string>

Responses

202

Successful Response

object
data
required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string