Importing clients

If you want to enrich your contact database, you can import customers to the application.

Requirements


  • User permissions to conduct such a data update.
  • The business profile API key must allow conducting imports.
  • Prepare a CSV file with customer details:
    • Every customer needs an identifier. It can be one of the following parameters: email, uuid, clientID, or customID.
      Warning: If you choose an email as a customer identifier, pay attention to the correct format of emails. Otherwise your import will fail.
    • Preferable date format: YYYY-MM-DD. If your date format is different, you can change it while mapping the data in the imported file.
    • Values for marketing agreements can take the following forms: TRUE/FALSE or 1/0.

Example

Exemplary file for a client import
Exemplary file for a client import

Procedure


  1. Go to Settings icon Settings > Import > New import.

  2. Choose the Clients as the type of the import.

  3. Choose the method of import.

  4. Enter the name of the import.

  5. Only for Pull imports: To define the access to your SFTP, in the Access section click the Define button. When you adjust the settings, confirm with the Apply button.

  6. Only for Pull imports: To define the frequency of imports, in the Schedule section click the Define button and adjust the settings. Confirm them with the Apply button.

  7. To upload a file with the data to be imported, in the Sample file section click the Define button.

    Important:
    • If you have chosen the File upload as the method of import, the file you upload here is is imported immediately after saving the import.
    • If you have chosen the Pull method, the file you upload here is imported at the time you scheduled.
    • In the case of the Push method, the file you upload here is just a sample file. More information about the import flow for every method is available at the link.

    • Choose the type of the file you are going to import.
    • To upload the file, click the + Upload file or drop one here button.
    • Confirm the action by clicking the Apply button.
  8. To proceed to the next step, click the Next button.

  9. Connect (map) the fields on the list on the left side to the columns. To do so, click the circle next to the field name and join it with an appropriate column. Use the items from the Required section and if needed, use items in the Optional section. As a result, under the column name, you can see the name of the field to which the column has been linked.

    A file before mapping
    A file before mapping

    There might be some cases when the field list lacks the fields equivalent to the column in your file. In such a case, you can create your own fields by clicking the Add field button on the bottom of the list. The name of the field must start with the attributes. prefix (for example, attributes.secondName). You can find the list of forbidden fields to be created this way at the bottom of this article.
    The image below presents the final result of mapping the columns.

    A file after mapping
    A file after mapping
  10. To proceed, click the Next button.

  11. Verify the mapping of the fields.

  12. To complete the process, click the Save button.

  13. Only for Push method imports: the Save button saves the mapping, and you get the webhook URL to send the data. You can use this mapping later for a single import of CSV files. To do so, go to the list of imports, and click the import. Click the Import data from CSV file. The structure of the file (number of columns, name of the columns, and the data format) must be the same.

Important: Depending on the import method you have chosen in the step 3, the flow of the import will vary.

  • If you have chosen the File upload method, the Save button completes the process. The import is processed immediately.
  • If you have chosen the Pull method, the Save button completes the process and the import will be processed at the scheduled time.

Forbidden fields


You are not allowed to create the following fields while mapping.

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
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.