Customers (Partial Update)
Description
If the UUID of the Customer exists in the system, or no UUID is provided and an External ID exists, then an update is performed on the provided fields. Note: to clear field set value to string SET_AS_NULL
See the Aerial Spec for more details.
File Naming Convention
TGEN_customers_partialupdate_2025-08_<optionalSuffix>.csv
importType:partialupdateapiVersion:2025-08
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
uuid | Unique Tulip identifier of the customer. | Max Length: 36 | string | No |
externalId | Integrator provided unique identifier for the customer. | Max Length: 255 | string | No |
firstName | First name of the customer. | Max Length: 64 | string | No |
lastName | Last name of the customer. | Max Length: 64 | string | No |
prefix | Customer name prefix (Title). | Max Length: 64 | string | No |
suffix | Customer name suffix. | Max Length: 64 | string | No |
disabled | Boolean dictating if customer status is disabled or not. | boolean | No | |
excludeFromCampaigns | Boolean dictating if customer is excluded from marketing campaigns or not | boolean | No | |
image | Image URL of the customer. | Max Length: 255 | string | No |
attributes | Attribute Values associated with this customer. Supports SET_AS_NULL. | string | No | |
attributes[0] | Attribute Value, External ID, UUID or SET_AS_NULL | mixed | No | |
attributes[0].value | Value of the attribute | mixed | Yes | |
attributes[0].attributeExternalId | “Integrator provided unique identifier for the attribute. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
attributes[0].languageExternalId | External ID of the language | Max Length: 255 | string | No |
addresses | Addresses associated with this Customer. Supports SET_AS_NULL. | string | No | |
addresses[0] | Address, External ID, UUID or SET_AS_NULL | mixed | No | |
addresses[0].uuid | Unique Tulip identifier of the address. | Max Length: 36 | string | No |
addresses[0].externalId | Integrator provided unique identifier for the address. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
addresses[0].address1 | Address line 1: street number and street name | Max Length: 64 | string | No |
addresses[0].city | City | Max Length: 32 | string | No |
addresses[0].countryCode | Country ISO code in ISO-3166-3 format | Max Length: 3 | string | No |
addresses[0].zoneCode | Concatenation of Country ISO code in ISO-3166-2 format and State/Province in ISO-3166-2 | Max Length: 255 | string | No |
addresses[0].postCode | Postal code of the address | Max Length: 10 | string | No |
addresses[0].address2 | Address line 2 | Max Length: 64 | string | No |
addresses[0].firstName | First name associated to the address | Max Length: 64 | string | No |
addresses[0].lastName | Last name associated to the address | Max Length: 64 | string | No |
addresses[0].phone | Phone number associated to the address (E.164 standard) | Max Length: 32 | string | No |
addresses[0].emailAddress | Email address associated to the address | Max Length: 255 | string | No |
addresses[0].type | Type of address | Max Length: 255 | string | No |
addresses[0].disabled | Boolean dictating if address is disabled (true or false) | boolean | No | |
addresses[0].isPrimary | Boolean dictating if address is the primary address for the customer | boolean | No | |
importantDates | Important Dates associated with this Customer. Supports SET_AS_NULL. | string | No | |
importantDates[0] | Important Date, External ID, UUID or SET_AS_NULL | mixed | No | |
importantDates[0].uuid | Unique Tulip identifier of the important date. | Max Length: 36 | string | No |
importantDates[0].type | Type of important date | Max Length: 255 | string | No |
importantDates[0].title | Description of the important date | Max Length: 255 | string | No |
importantDates[0].date | Important date of the customer in RFC3339 format | string | No | |
importantDates[0].externalId | Integrator provided unique identifier for the important date. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
emailAddresses | Email Addresses associated with this Customer. Supports SET_AS_NULL. | string | No | |
emailAddresses[0] | Email Address, External ID, UUID or SET_AS_NULL | mixed | No | |
emailAddresses[0].uuid | Unique Tulip identifier of the email address. | Max Length: 36 | string | No |
emailAddresses[0].externalId | Integrator provided unique identifier for the email address. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
emailAddresses[0].emailAddress | The email address. | Max Length: 255 | string | No |
emailAddresses[0].type | Type of email address. | Max Length: 255 | string | No |
emailAddresses[0].isPrimary | Boolean dictating if this is the primary email address for the customer. | boolean | No | |
emailAddresses[0].disabled | Boolean dictating if the email address is disabled (true or false). | boolean | No | |
emailAddresses[0].attributes | Attribute Values associated with this email address. Supports SET_AS_NULL. | string | No | |
emailAddresses[0].attributes[0] | Attribute Value, External ID, UUID or SET_AS_NULL | mixed | No | |
emailAddresses[0].attributes[0].value | Value of the attribute | mixed | Yes | |
emailAddresses[0].attributes[0].attributeExternalId | “Integrator provided unique identifier for the attribute. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
emailAddresses[0].attributes[0].languageExternalId | External ID of the language | Max Length: 255 | string | No |
phoneNumbers | Phone Numbers associated with this Customer. Supports SET_AS_NULL. | string | No | |
phoneNumbers[0] | Phone Number, External ID, UUID or SET_AS_NULL | mixed | No | |
phoneNumbers[0].uuid | Unique Tulip identifier of the phone number. | Max Length: 36 | string | No |
phoneNumbers[0].externalId | Integrator provided unique identifier for the phone number. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
phoneNumbers[0].type | Type of phone number | Max Length: 255 | string | No |
phoneNumbers[0].disabled | Boolean dictating if the phone number is disabled (true or false) | boolean | No | |
phoneNumbers[0].isPrimary | Boolean dictating if the phone number is the primary phone number for the customer | boolean | No | |
phoneNumbers[0].number | Phone number for the customer in E.164 standard | Max Length: 32 | string | No |
phoneNumbers[0].countryExternalId | External ID of the country this phone number belongs to. Detected automatically using number if not provided. | string | No | |
phoneNumbers[0].attributes | Attribute Values associated with this phone number. Supports SET_AS_NULL. | string | No | |
phoneNumbers[0].attributes[0] | Attribute Value, External ID, UUID or SET_AS_NULL | mixed | No | |
phoneNumbers[0].attributes[0].value | Value of the attribute | mixed | Yes | |
phoneNumbers[0].attributes[0].attributeExternalId | “Integrator provided unique identifier for the attribute. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | Yes |
phoneNumbers[0].attributes[0].languageExternalId | External ID of the language | Max Length: 255 | string | No |
loyaltyTiers | Loyalty Tiers associated with this Customer. Supports SET_AS_NULL. | string | No | |
loyaltyTiers[0] | Loyalty Tier, External ID, UUID or SET_AS_NULL | mixed | No | |
loyaltyTiers[0].uuid | Unique Tulip identifier of the Tier Value | string | Yes | |
loyaltyTiers[0].tier | Identifier of the associated Customer Tier | string | Yes | |
loyaltyTiers[0].colour | The colour associated with the tier in Hex format | Max Length: 255 | string | No |
loyaltyTiers[0].definition | The definition of this tier value | string | No | |
loyaltyTiers[0].externalId | External identifier of the Tier Value | Max Length: 255 | string | No |
loyaltyTiers[0].isHidden | Boolean dictating if Tier Value is hidden (true or false) | Max Length: 255 | boolean | Yes |
loyaltyTiers[0].localizedData | Array of localized Tier Value descriptions | array | No | |
loyaltyTiers[0].localizedData[0] | Array element | mixed | No | |
loyaltyTiers[0].localizedData[0].languageCode | Language code the Tier Value is in | string | Yes | |
loyaltyTiers[0].localizedData[0].name | The localized name of the Tier Value | Max Length: 255 | string | Yes |
preferences | N/A | mixed | No | |
preferences.likes | Array of liked customer preferences. Supports SET_AS_NULL. | string | No | |
preferences.likes[0] | Liked customer preference, External ID, UUID or SET_AS_NULL | mixed | No | |
preferences.likes[0].uuid | Unique Tulip identifier of the customerPreferenceValue | Max Length: 36 | string | No |
preferences.likes[0].externalId | External ID of the customerPreferenceValue | Max Length: 255 | string | No |
preferences.likes[0].disabled | Boolean dictating if this preference value is disabled (true or false) | boolean | No | |
preferences.likes[0].type | The customer preference this value belongs to (External ID or UUID) | mixed | Yes | |
preferences.likes[0].type.externalId | Integrator provided unique identifier for the customer preference. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
preferences.likes[0].type.displayType | Display type for this preference | Allowed: hexColor, image, text | string | Yes |
preferences.likes[0].type.sortOrder | Sort order for this preference in the list | integer | Yes | |
preferences.likes[0].type.allowDislikes | Boolean dictating if dislikes are allowed for this preference (true or false) | boolean | No | |
preferences.likes[0].type.isSingleSelect | Boolean dictating if only one value can be assigned per-customer (true or false) | boolean | No | |
preferences.likes[0].type.isFilterable | Boolean dictating if value is filterable or not (true or false) | boolean | No | |
preferences.likes[0].type.disabled | Boolean dictating if this preference is disabled (true or false) | boolean | No | |
preferences.likes[0].type.localizedData | Localized data for name and description with associated language | array | No | |
preferences.likes[0].type.localizedData[0] | Array element | mixed | No | |
preferences.likes[0].sortOrder | Sort order for this preference value in the list | integer | Yes | |
preferences.likes[0].localizedData | Localized data for value and presentation with associated language | array | No | |
preferences.likes[0].localizedData[0] | Array element | mixed | No | |
preferences.likes[0].localizedData[0].value | Value of the Customer Preference Value | Max Length: 36 | string | Yes |
preferences.likes[0].localizedData[0].presentation | Presentation of the Customer Preference Value localization (URL, Hex or String) | Max Length: 255 | string | No |
preferences.likes[0].localizedData[0].languageCode | Language code the Customer Preference Value is in | string | Yes | |
preferences.dislikes | Array of disliked customer preferences. Supports SET_AS_NULL. | string | No | |
preferences.dislikes[0] | Disliked customer preference, External ID, UUID or SET_AS_NULL | mixed | No | |
preferences.dislikes[0].uuid | Unique Tulip identifier of the customerPreferenceValue | Max Length: 36 | string | No |
preferences.dislikes[0].externalId | External ID of the customerPreferenceValue | Max Length: 255 | string | No |
preferences.dislikes[0].disabled | Boolean dictating if this preference value is disabled (true or false) | boolean | No | |
preferences.dislikes[0].type | The customer preference this value belongs to (External ID or UUID) | mixed | Yes | |
preferences.dislikes[0].type.externalId | Integrator provided unique identifier for the customer preference. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
preferences.dislikes[0].type.displayType | Display type for this preference | Allowed: hexColor, image, text | string | Yes |
preferences.dislikes[0].type.sortOrder | Sort order for this preference in the list | integer | Yes | |
preferences.dislikes[0].type.allowDislikes | Boolean dictating if dislikes are allowed for this preference (true or false) | boolean | No | |
preferences.dislikes[0].type.isSingleSelect | Boolean dictating if only one value can be assigned per-customer (true or false) | boolean | No | |
preferences.dislikes[0].type.isFilterable | Boolean dictating if value is filterable or not (true or false) | boolean | No | |
preferences.dislikes[0].type.disabled | Boolean dictating if this preference is disabled (true or false) | boolean | No | |
preferences.dislikes[0].type.localizedData | Localized data for name and description with associated language | array | No | |
preferences.dislikes[0].type.localizedData[0] | Array element | mixed | No | |
preferences.dislikes[0].sortOrder | Sort order for this preference value in the list | integer | Yes | |
preferences.dislikes[0].localizedData | Localized data for value and presentation with associated language | array | No | |
preferences.dislikes[0].localizedData[0] | Array element | mixed | No | |
preferences.dislikes[0].localizedData[0].value | Value of the Customer Preference Value | Max Length: 36 | string | Yes |
preferences.dislikes[0].localizedData[0].presentation | Presentation of the Customer Preference Value localization (URL, Hex or String) | Max Length: 255 | string | No |
preferences.dislikes[0].localizedData[0].languageCode | Language code the Customer Preference Value is in | string | Yes | |
socialProfiles | Social profiles associated with this customer. Supports SET_AS_NULL. | string | No | |
socialProfiles[0] | Social Profile, External ID, UUID or SET_AS_NULL | mixed | No | |
socialProfiles[0].uuid | Unique Tulip identifier of the social profile. | Max Length: 36 | string | No |
socialProfiles[0].externalId | Integrator provided unique identifier for the social profile. Typically used to map a primary key from a third party system to the Tulip resource. | Max Length: 255 | string | No |
socialProfiles[0].type | Type of social profile. | Max Length: 255 | string | No |
socialProfiles[0].value | Value of the social profile (e.g., username, phone number, URL). | Max Length: 255 | string | No |
socialProfiles[0].isPrimary | Boolean dictating if this is the primary social profile of this type for the customer. | boolean | No | |
socialProfiles[0].disabled | Boolean dictating if the social profile is disabled (true or false). | boolean | No |
Sample CSV
See the following customers CSV sample file.