v1Resources/Locations/postStart a client migration

Start a client migration

Requires the same owner/admin and agency-wide credentials as the preview. Pass its token with the same locations and target. The executor rechecks the plan and refuses changed or stale plans with 409. Returns a job ID with 202; poll progress for completion or partial failures.

post/api/v1/locations/migrate
locations:write
Request body
locationIdsarray of stringrequired
Selected location IDs or public IDs.
toClientIdstringrequired
Destination managed-client ID or public ID.
tokenstringrequired
Signed token from the reviewed preview; never generate or substitute one.
Response
dataobjectoptional
jobIdstringoptional
totalintegeroptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409Content checks held the action, or the migration preview is stale or changed.
422The location operation needs attention or could not be completed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The location operation needs attention or could not be completed.
post/api/v1/locations/migrate
Your API key
Request body*
{}

Guides that use this resource