Importing profiles

After importing profiles to Synerise, you can direct various actions towards them, such as:

Sending messages (email, SMS, mobile push, web push, in-app messages).
Creating predictions.
Creating query rules in AI search engine.

Requirements

You need user permissions that grant you access to Simple Imports or/and Automation
Prepare a file that contains one of the following profile identifiers: (the list contains recommended column names, if you use different names you will be able to map/transform data during the process):
- email - use it only if you use unique emails in Synerise. If you use non-unique emails, don’t use email as an identifier during the import, use customId instead.
- uuid,
- clientId - can be used only when updating an existing profile
- customId,
- phone - Phone number is treated as an identifier only if no other identifier is provided. Then, if a profile with this phone number does not exist and non-unique emails are disabled, an anonymous profile is created.
  This is the only required column, the rest is optional.
  WARNING: If you choose an email as an identifier, pay attention to the correct format of emails. Otherwise, your import will fail.
- Spaces and special characters in the column headers are not allowed.
- .csv files must be UTF-8 encoded
- Maximum file size: 200 MB.

Tips for preparing a CSV file

Recommended file metacharacters:
- A character that splits columns (delimiter): ,
- A character that is used to contain the text (quotation mark): "
- A character (escape character) that changes the default interpretation of a sign or string followed by the escape character: \
Attributes (column names) and values are case-sensitive (firstname and Firstname are not the same)
If you will use Automation as a method of import, below you can find the instructions how to transform the optional default profile properties:

Profile’s property	Required name	Accepted values	Other comments
Profile’s first name	`firstName`	A string	n/a
Profile’s last name	`lastName`	A string	n/a
Date of birth in the profile	`birthDate`	the `yyyy-mm-dd` format, months must be zero-padded (for example, May is `05`)	For example, `1999-09-09`
Profile’s company	`company`	A string	n/a
Profile’s city of residence	`city`	A string	n/a
Profile’s street address	`address`	A string	n/a
Profile’s zip code	`zipCode`	A string	n/a
Profile’s province of residence	`province`	A string	n/a
Code of profile’s country of residence in accordance with the ISO 3166 format	`countryCode`	A string	n/a
Profile’s gender	`sex`	`FEMALE`, `MALE`, `OTHER`, `NOT_SPECIFIED`	These values are transformed during import as follows: - NOT SPECIFIED and OTHER to `0` - FEMALE to `1` - MALE to `2` These values will be presented as such in a profile’s card
Marketing agreements of the profile	- for email: `agreements.email` - for web push: `agreements.webPush` - for mobile push: `agreements.push` - for SMS: `agreements.sms`	- for email: `true`, `false`, `True`, `False`, `1` (true), `O` (false) - for web push: `true`, `false` - for mobile push: `true`, `false` - for SMS: `true`, `false`	If you use non-unique emails, email marketing agreement is saved as a custom attribute which takes the following values: `enabled`, `disabled`
Tags assigned to a profile	`tags`	An array of strings	n/a
A profile’s phone number	`phone`	The phone number can contain digits, spaces, and an optional `+` at the beginning.	For example: `+48111222333`; `+48 111 222 333`

Example

Exemplary file for a profile import

For more details about parameters and their accepted formats, click here.

Procedure

Selecting the file for import

In this part of the process, you will upload a file from your device.

Go to Data Management > Data import > New import.
As the data type for import, select Profiles.
As the import method, select one of the following options:
- Import a local file - To import a single .csv file to Synerise.
- Import in Automation - To import a .csv, .json, .jsonl, and .xml files and execute periodical imports.

Upload the .csv file by using the + Upload file or drop one here field.
Optionally, you can customize the file metacharacters by clicking the arrow down icon.
1. From the Delimiter dropdown, select the character that marks the end of a column.
2. From the Quotation mark dropdown list, select the characters that contain the text or data type.
3. From the Escape character dropdown lists, select the character which changes the default interpretation of a character or a string followed by the escape character.
To proceed to the next step, click the Next button.

Mapping the columns with parameters in Synerise

In this part of the process, you will connect the columns from the file with their counterparts (the existing parameters) in Synerise. This way, you will point which parameters in Synerise will contain the profile information from the imported file.
You can also exclude parameters from the import. During the mapping process, you can’t add new columns to the imported file.

On the user interface, you will be presented with two columns - the left column displays the names of the columns from the imported file, the other contains dropdown lists with the parameters available in Synerise. The dropdown lists indicate required parameters for a successful import.

Next to the file column name, from the dropdown list, select the corresponding parameter in Synerise. Perform this step for all columns in your file.
To exclude a parameter from import, next to the column name, click this icon:
Result: The icon changes to

Launching import

After steps described above you’ll be redirected to the mapping summary. If it’s correct, to launch the import, click Run import.

Reserved parameters

You are not allowed to create the following parameters while mapping. These are default parameters available in Synerise (they already exist in Synerise).

address	agreements	anonymous	anonymous_type
avatarUrl	birthdate	birthDate	businessProfileId
city	clientId	company	confirmation_hash
confirmed	countryCode	country_id	created
customId	custom_identify	deletedAt	displayname
displayName	email	external_avatar_url	facebookId
firstname	firstName	geo_loc_as	geo_loc_city
geo_loc_country	geo_loc_country_code	geo_loc_isp	geo_loc_lat
geo_loc_lon	geo_loc_org	geo_loc_query	geo_loc_region
geo_loc_region_name	geo_loc_status	geo_loc_timezone	geo_loc_zip
ip	lastname	lastName	last_activity_date
newsletter_agreement	ownerId	phone	province
receive_btooth_messages	receive_push_messages	receive_rfid_messages	receive_smses
receive_webpush_messages	receive_wifi_messages	sex	source
tags	time	type	updated
uuid	zipCode