Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
    • Authentication
    • Base URL
    • Batch file formatting requirements
        • Guest data model
        • Send additional guest data
        • Guest extension data model
        • Guest extension data model for flight
        • Guest identifiers data model
        • Using guest profile migration
        • Guest migration data model
        • Using guest delete
        • Guest delete data model
  1. Batch API Guest
  1. Batch API
  2. Batch API Guest
  3. Using guest profile migration

Using guest profile migration

The Sitecore CDP Guest Profile Migration API is used to migrate guest profile entities from one guest profile to another. After migration, the old guest profile is retired.

This offline procedure is only performed in exceptional circumstances when you want to synchronize guest profiles, for example, if your organization is going to be using Sitecore CDP and you want to synchronize guest profiles from your existing Data Management Platform (DMP) with those in Sitecore CDP.

Guest profiles are always migrated, and never merged. When migrating guest profiles, the Sitecore CDP Batch API migrates the following entities:

  • Sessions (including browser history)

  • Orders

  • Flow executions (including tracking data)

No details on the guest profile are updated, such as first name and last name, during or after the migration.

The sequence that you migrate guest profiles and update the order data does not matter. You can either migrate the guest profile and then update the order information, or update the order information then migrate the guest profile.

Do not change details on the order.contact or order.consumer, prior to performing the migration. For example, if you change the passportExpiry or any other attributes listed in the Order Contact Data Model table or Order Consumer Data Model table, you must perform an Update Order Contact or Update Order Consumer function, as applicable.

Caution

We recommend that you migrate a maximum of 200,000 guest profiles per day.

The following applies when migrating guests:

  • Guests with open sessions - guests with open sessions are listed in the log file with the Unable to migrate Guest with open session error. You can migrate these guests later when their session(s) are closed.

  • Guests who are the contact on the order - the order contact is migrated to the new guest profile.

  • Guests who are the consumer on the order - the order consumer is migrated to the new guest profile.

  • Flow executions and tracking data - all flow executions and tracking data associated with the old guest profile are migrated to the new guest profile.

  • Browsers - all browsers associated with the old guest profile are migrated to the new guest profile.

  • Sessions and browsing history - all sessions and browsing history associated with the old guest profile are migrated to the new guest profile.

  • After the migration is performed, the old guest profile is retired and permanently archived. The retired guest profile can not be accessed through the Sitecore CDP APIs or within the UI.

This offline procedure is only performed in exceptional circumstances when you want to migrate guest profile entities from one guest profile to another. After the migration, the old guest profile is retired. You can only use this procedure if your organization uses identifiers to perform identity resolution.

When migrating guest profiles, the Sitecore CDP Batch API migrates the following entities:

  • Sessions (including browser history)

  • Orders

  • Flow executions (including tracking data)

No details on the guest profile are updated, such as first name and last name, during or after the migration.

The sequence that you migrate guest profiles and update the order data does not matter. You can either migrate the guest profile and then update the order information, or update the order information then migrate the guest profile.

Caution

You can only migrate a maximum of 200,000 guest profiles per day.

The following applies when migrating guests:

  • Guests with open sessions - guests with open sessions are listed in the log file with the Unable to migrate Guest with open session error. You can migrate these guests later when their session(s) are closed.

  • Guests who are the contact on the order - the order contact is migrated to the new guest profile.

  • Flow executions and tracking data - all flow executions and tracking data associated with the old guest profile are migrated to the new guest profile.

  • Browsers - all browsers associated with the old guest profile are migrated to the new guest profile.

  • Sessions and browsing history - all sessions and browsing history associated with the old guest profile are migrated to the new guest profile.

  • After the migration is performed, the old guest profile is retired and permanently archived. The retired guest profile can not be accessed through the Sitecore CDP APIs or within the UI.

If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use