Customer Lists (Full Update)
Description
If a UUID or External ID is provided and exists, the Customer List will be updated. Otherwise, it will be created.
See the Aerial Spec for more details.
File Naming Convention
TGEN_customerLists_fullupdate_2025-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-08
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
uuid | UUID of the resource | string | No | |
externalId | External ID of the resource | Max Length: 255 | string | No |
status | N/A | mixed | No | |
type | N/A | mixed | No | |
startDate | Datetime of when the Customer List will begin to be visible in the application. When null, will always be visible before the endDate. | string | No | |
endDate | Datetime of when the Customer List will no longer be visible in the application. When null, will always be visible after the startDate. | string | No | |
secondaryMetric | A customer field or attribute to display alongside loyalty tier information on the customer list UI. Must be a top-level field on the Customer resource or an attribute. | Pattern: /^customer\.(uuid|externalId|firstName|lastName|prefix|suffix|disabled|excludeFromCampaigns|image|dateCreated|dateModified|lastPurchaseOrderId|lastPurchaseStatusId|lastPurchaseDate|lastRefundOrderId|lastRefundDate|numberOfPossibleDuplicates|lastOutreachDate|lastOutreachType|createdStoreUuid|createdStoreExternalId|attributes(\.\w+))/$ | string | No |
stores | List of stores that can view the list, if no associates are provided below, then all associates in the specified stores can view the list. | array | No | |
stores[0] | Array element | mixed | No | |
associates | List of employees who can view the list | array | No | |
associates[0] | Array element | mixed | No | |
localizations | Contains the different localizations for strings associated to this resource. Resolve the best known language on the client based on available languages, not all languages are always provided. | array | No | |
localizations[0] | Array element | mixed | No | |
localizations[0].title | Title of the customer list in the current language | string | Yes | |
localizations[0].description | Description of the customer list in the current language | string | No | |
localizations[0].languageCode | Language this localization pertains to, follows a pattern of 2 letters and can then have multiple other groups of 2 letters or more. Each block separated by an hyphen. | Max Length: 32 Min Length: 2 Pattern: ^[a-z]{2}(-[a-z]{2,})*$ | string | No |
Sample CSV
See the following customerLists CSV sample file.