User data migration

This reference article will run through all the considerations you’ll need to keep in mind when you’re migrating your user data to Braze.

Format user phone numbers to carrier standards

Phone carriers have a specific type of format they expect called E.164 which is the international telephone numbering plan that ensures that each device has a globally unique number. This is what allows phone calls and text messages to be correctly routed to individual phones in different countries. E.164 numbers are formatted as shown in the following image and can have a maximum of fifteen (15) digits. Learn more about user phone numbers.

Adding aliases to the user profiles

Aliases are necessary to be able to capture any custom events or custom keyword responses. You will want to set the “alias label” to “phone” and the “alias name” to the user’s phone number.

Update historical information on users subscription states

If you have any historical information about your user’s subscription states for your various messaging channels, be sure to update this information in Braze.

Example migration steps

Before you begin composing SMS campaigns through Braze, you’ll need to update your user data to ensure that all of this works.

Here’s a quick summary of the user data you’ll need to update in Braze:

1. Import users’ phone numbers in the correct format (E.164) formatting requires a plug sign “+” and a country code (e.g., +12408884782). For more information on how to import user phone numbers, refer to user phone numbers.
   • Use the /users/track endpoint to assign the phone value.
     
     
2. Add a user alias to identified user profiles with a user’s phone number. The required format for this is alias_label: ‘phone’ and alias_name: ‘+12408884782’
   • Use the /users/alias/new endpoint to assign an alias to existing user profiles.
   • There are also SDK methods for aliasing users iOS / Android / Web.
     
     
3. Assign your user’s SMS subscription state (e.g.,subscribed or unsubscribed) if you have this information.
   • Use the /subscription/status/set endpoint to set users as subscribed or unsubscribed from your SMS Subscription Groups.
   • Note that once the SMS Subscription Groups have been configured in your dashboard, you’ll be able to grab the necessary subscription_group_id which you’ll need for your API request.