Customer Lists (Partial Update)
Description
Creates or updates a customer list with the given uuid or externalId. Performs an update if a resource with the given externalId or uuid exists. Note: To clear any field, set the value to “SET_AS_NULL”
See the Aerial Spec for more details.
File Naming Convention
TGEN_customerLists_partialupdate_2026-08_<optionalSuffix>.csv
importType:partialupdateapiVersion: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 that can be expressed using a value as defined in its types. | string | No | |
externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
status | Status of the customer list that can be expressed using a value as defined in its types. | string | No | |
type | Type of the customer list that can be expressed using a value as defined in its types. | Allowed: corporate, dynamic, dynamic_default | string | 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. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | 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. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | 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 |
anchoringMetric | Anchoring metric for the customer list that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
visibility | Visibility level for the customer list that can be expressed using a value as defined in its types. | Allowed: all, associate, manager | string | No |
position | Sort position within type (lower values appear first) that can be expressed using a value as defined in its types. | integer | 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 | |
customers | A collection of customers that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | Not a CSV column header. Pass each array element in its own indexed column (customers[0], customers[1], and so on). | array | No |
customers[0] | Array element | mixed | No | |
stores | A collection of stores that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | 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 | A collection of associates that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | 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 |
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. You may omit any non-required fields from the sample CSV, reference the table above for required fields.