Import and create user profiles

User profiles can be created manually, which can be useful for quick tests during initial integration; however, larger lists can be uploaded directly, and the API can be used to keep user profiles in sync with your backend profiles automatically, also automated imports can be configured.

Manual entry

Navigate to Data > User Profiles and click the Create User Profile button.

All fields are optional; fill in the fields needed for the new profile. For example if adding a profile for email, add the email address and set email subscription to yes. Click the Create Profile button to save the new user profile.

📘

SMS Mobile Number

Mobile number for SMS must be added in the E.164 international format with the country code, without a plus (+) symbol.

Eg. An Ireland mobile number 0850123456 should be entered with the 353 Ireland country code as 353850123456.
A UK mobile number 07400123456 should be entered with the 44 UK country code as 447400123456.

Import user profiles

You can also add test users or set up an initial list of users from a CSV file. The file needs to have a name for each column in the he first row (or column header). A column for user_id is required and custom Profile Attributes can also be set by adding more columns to the file with the data and including the attribute name as the column header.

There are a number of reserved field names that map to system attributes. These are listed in the Attributes guide.

Below is a sample CSV which demonstrates the system attributes, and includes a custom attribute called first_name:

user_id,email,email_subscription,mobile_number,sms_subscription,language,timezone,first_name
fe56bc676be78,[email protected],1,353850123456,1,en,Europe/Dublin,Sam
fe56bc676be79,[email protected],1,353850123457,1,en,Europe/London,Laura

📘

CSV format

Your CSV file must follow the standard format, which most desktop software will do automatically.

If you need to configure your CSV format, fields should be separated by commas, and quoted using double-quotes when containing reserved characters. Technical details can be found in RFC 4180.

To import the file, go to Data > User Profiles and click the Import User Profiles button. This process has two steps to select the data source and to map the columns to attributes.

Data Source

After giving the import a name, choose the data source:

  • The File Storage option allows users to import files from an SFTP site configured in Integrations marketplace, which is useful to run imports from a third party platform.
  • Select Upload to choose a CSV from your computer.

Data Mapping

Once that you have imported the file from either data source, click on Next Step to map the data.

If the CSV headers exactly match the attribute names, the data for the user profiles will be mapped to fields automatically. Otherwise, users can choose to not import the data for that column altogether (this option is selected by default (Don't import)) or map the data to the desired field by selecting it from a drop-down menu.

🚧

Available attributes

It is only possible to select existing attributes in the project, so make sure to create any desired profile attributes before importing user profiles.

Once you have completed mapping the columns of the CSV file, click on Run import to complete it.

Automated imports

A regular import of user profiles from a third party platform can be set up using Automated imports.

Via API

To keep user profiles in sync with your own backend system, we recommend using the API.

The API method for importing user profiles can be found in the User Profile Import API reference.

You can find general information on the Xtremepush APIs in the External API Overview.

Updated 25 days ago


Import and create user profiles


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.