Onboarding - Uploading to AWS S3

OVERVIEW

This article will overview how to upload to AWS S3 to upload both Onboarding (emails-to-behaviors) and Onboarding Opt-Out (list of emails to opt-out of Lotame onboarding) files. The file formats are described in the Onboarding - File Format article. If you do not have an automated way to upload files, please see our Onboarding: Manually Uploading Files to Lotame S3 guide.

---

EMAIL File Uploads

Lotame supports two file types for uploading plaintext emails and SHA-256 encoded emails: JSON and CSV. Descriptions of their formats are below.

These files will be uploaded to the DATA directory: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=<client_id>/type=DATA/<filename>

CSV

For CSV, the filenames are required to be:

• PlainText Email: <custom_name>_EMAIL.csv
  • Example: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=DATA/newsletter_subscribers_EMAIL.csv 
• SHA-256 Encoded Email: <custom_name>_EMAIL_SHA256.csv
  • Example: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=DATA/newsletter_subscribers_EMAIL_SHA256.csv

Note: The value <custom_name> is created by you. It should be something that you describes your dataset. So if you have multiple files uploaded, you will be able to know which is what when interacting with them in the Lotame Platform UI.

Note 2: The EMAIL or EMAIL_SHA256 values in the filename must be uppercased.

Note 3: The file may be optionally GZIP to allow for faster data transfer. Thus the filename would end in .csv.gz

JSON

 

Below is the description of the file formatting specs of the JSON file. This file will contain the emails (plaintext or SHA-256 encoded) and behaviors. Each row in the file is a JSON object for a single email without line breaks. 

For JSON, the filenames are required to be:

• PlainText Email: <custom_filename>_EMAIL.json
  • Example: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=DATA/newsletter_subscribers_EMAIL.json
• SHA-256 Encoded Email: <custom_filename>_EMAIL_SHA256.json.gz
  • Example: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=DATA/newsletter_subscribers_EMAIL_SHA256.json

Note: The value <custom_name> is created by you. It should be something that you describes your dataset. So if you have multiple files uploaded, you will be able to know which is what when interacting with them in the Lotame Platform UI.

Note 2: The EMAIL or EMAIL_SHA256 values in the filename must be uppercased.

Note 3: The file may be optionally GZIP to allow for faster data transfer. Thus the filename would end in .json.gz

OPTOUT File Uploads

The Opt-Out file(s) allow you to upload a list of emails that you want opted-out of processing. If there is more than one Opt-Out file uploaded, Lotame processing concatenates them and de-deduplicates them. That combined and deduplicated list is then process across all of your active Data files.

• File Upload Location: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=<client_id>/type=OPTOUT/<filename>
• File Names:
  • PlainText Email: <custom_filename>_EMAIL.csv
    • Example: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=OPTOUT/newsletter_optout_list_EMAIL.csv
  • SHA-256 Encoded Email: <custom_filename>_EMAIL_SHA256.csv
    • Examples: s3://lotame-transfer-in-us-east-1/onboarding/in/client_id=12345/type=OPTOUT/newsletter_optout_list_EMAIL_SHA256.csv

Note: The value <custom_name> is created by you. It should be something that you describes your dataset. So if you have multiple files uploaded, you will be able to know which is what when interacting with them in the Lotame Platform UI.

Note 2: The EMAIL or EMAIL_SHA256 values in the filename must be uppercased.