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. Guest migration data model

Guest migration data model

When you create a batch file, ensure that you include all required attributes in addition to any attributes from the following table:

Attribute

Description

Type

Example(s)

Required/optional

ref

A unique ID of the record that the organization generates for the purpose of identification outside of Sitecore CDP.

string UUID

"888E80C5-370E-4EE8-80D7-3A89DC064509"

Required

schema

The type of record contained in the value field that is being imported.

string

"migration"

Required

mode

Supports migration of guest entities including orders, browsing history, and flow execution history.

string

"guest"

Required

value

The container for the migrateFrom and migrateTo attributes.

container

N/A

Required

migrateFrom

The container for the identifiers array for the guest record.

container

N/A

Required

identifiers

The container for the provider and the id for the guest that is being migrated.

container

N/A

Required

provider

The provider of the identifier.

string

"IDENTITY_SYSTEM"

Required

id

The unique ID of the identifier.

string

"BX_201504"

Required

migrateTo

The container for the identifiers array for the guest record.

container

N/A

Required

{  
   "ref":"888E80C5-370E-4EE8-80D7-3A89DC064509",
   "schema":"migration",
   "mode":"guest",
   "value":{  
      "migrateFrom":{  
         "identifiers":[  
            {  
               "provider":"IDENTITY_SYSTEM",
               "id":"BX_201504"
            }
         ]
      },
      "migrateTo":{  
         "identifiers":[  
            {  
               "provider":"IDENTITY_SYSTEM",
               "id":"BX_201505"
            }
         ]
      }
   }
}
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