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_2026-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2026-08
Columns
Nested object fields are flattened into columns using dot notation (parent.child). Array fields are flattened using zero-based index notation, one element per column (field[0], field[1], and so on).
Note: A whole array cannot be passed in a single column: a literal value such as ['value-1','value-2'] will be rejected. To import multiple array elements, add one indexed column per element. Rows in the table below with type array describe the field as a whole and are not valid CSV column headers.
| 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 |
anchoringMetric | Anchoring metric for the customer list | string | No | |
visibility | Visibility level: all (default), associate, or manager | Allowed: all, associate, manager | 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. | Not a CSV column header. Pass each array element in its own indexed column (stores[0], stores[1], and so on). | array | No |
stores[0] | Array element | mixed | No | |
associates | List of employees who can view the list | Not a CSV column header. Pass each array element in its own indexed column (associates[0], associates[1], and so on). | 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. | Not a CSV column header. Pass each array element in its own indexed column (localizations[0], localizations[1], and so on). | 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 code this localization pertains to. This code must match BCP-47 standard. | Max Length: 32 Min Length: 2 | string | No |
source | Source of the customer list (required for “dynamic” and “dynamic_default” types, optional for “corporate”) | mixed | No | |
source.sourceType | Type of the source | Allowed: segment | string | Yes |
source.sourceExternalId | External ID of the source | string | Yes | |
source.sourceCacheTtl | Cache TTL in seconds. When null, defaults to 1 hour (3600 seconds) | Min: 0 | integer | No |
source.sourceOrderingField | Optional override of the segment’s default sort column. Must match one of the segment’s rule or additionalField aliases; falls back to the segment default when the alias is unknown. | string | No | |
position | Sort position within type (lower values appear first) | Min: 0 | integer | No |
Sample CSV
See the following customerLists CSV sample file.
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment.