Employees (Partial Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_employees_partialupdate_2025-12_<optionalSuffix>.csv
importType:partialupdateapiVersion:2025-12
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
externalId | Integrator provided unique identifier for the employee. | Max Length: 255 | string | No |
uuid | Unique Tulip identifier of the employee. Required for patching. | Max Length: 36 | string | No |
samlNameId | If using SSO for authentication against a third party system, set the login username in this field if different than the value set in externalId. | string | No | |
disabled | Boolean dictating if employee is disabled (true or false) | boolean | No | |
store | Unique Tulip identifier of the store the employee is associated with | Max Length: 36 | string | No |
displayName | Name that will be displayed for the employee | string | No | |
firstName | First name of the employee | Max Length: 255 | string | No |
lastName | Last name of the employee | Max Length: 255 | string | No |
emailAddress | Email address of the employee | Max Length: 255 | string | No |
image | Image associated with the employee | string | No | |
mobileNumber | Mobile number for the employee in E.164 standard | string | No | |
jobTitle | Job title of the employee | Max Length: 255 | string | No |
liveConnectAvailability | Boolean dictating whether live connect is available or not for the employee (true or false) | boolean | No | |
attributes | Attribute Values associated with this employee. Supports SET_AS_NULL. | mixed | No | |
attributes[0] | Attribute Value, External ID, UUID or SET_AS_NULL | mixed | No | |
attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types | mixed | Yes | |
attributes[0].name | External ID of the attribute | Max Length: 255 | string | Yes |
attributes[0].languageExternalId | External ID of the language, defaults to english | Max Length: 255 | string | Yes |
attributes[0].attributeId | Tulip ID of the Attribute | Min: 0 | integer | No |
attributes[0].description | Tulip Attribute description | Max Length: 255 | string | Yes |
attributes[0].type | Tulip Attribute Type | Allowed: string, boolean, integer, float | string | Yes |
signature | Object containing the signature of the employee. Supports SET_AS_NULL. | mixed | No | |
signature.content | The signature of the employee | string | Yes | |
profile | Object containing the profile of the employee. Supports SET_AS_NULL. | mixed | No | |
profile.phoneNumber | The profile phone number of the employee in E.164 format | string | No | |
offlineNotificationConfig | Object containing the offline notification config of the employee. Supports SET_AS_NULL. | mixed | No | |
offlineNotificationConfig.forwardingNumber | Forwarding number for the employee in E.164 standard | string | No | |
offlineNotificationConfig.forwardingEnabled | Boolean dictating if employee has forwarding enabled (true or false) | boolean | No | |
offlineNotificationConfig.forwardAllEnabled | Boolean dictating if all messages should be forwarded to the employee (true or false) | boolean | No | |
offlineNotificationConfig.forwardLoggedOutEnabled | Boolean dictating if messages should be forwarded when employee is logged out (true or false) | boolean | No | |
authUser | Object containing the user of the employee | mixed | No | |
authUser.username | The username of the employee | string | Yes | |
authUser.password | The password of the employee | string | No | |
authUser.disabled | Boolean dictating if user is disabled (true or false) | boolean | No | |
authUser.roles | Array of role external ID’s | array | No | |
authUser.roles[0] | Array element | string | No |
Sample CSV
See the following employees 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.