This document provides comprehensive information about the headers and field requirements for importing leads through FTP.
Field Structure Overview
The lead import file expects 50 fields (positions 0-50) followed by any custom fields.
FTP File Fields
Col # |
Name |
Description |
Required |
Acceptable Values/Format |
|---|---|---|---|---|
0 |
LeadSourceName |
Identifies the source of the lead |
Yes |
Max 50 chars, must exist in system |
1 |
LeadTypeName |
Categorizes the type of lead |
Yes |
Max 50 chars, must exist in system |
2 |
LeadCategoryName |
Further categorizes the lead |
Yes |
Max 50 chars, must exist in system |
3 |
LeadCampaignName |
Campaign associated with lead |
No |
Max 300 chars |
4 |
Brands |
Brand name |
No |
Max 100 chars |
5 |
EventName |
Event where lead was captured |
No |
Max 100 chars |
6 |
LeadDate |
Date the lead was created |
Yes |
Date format: yyyy-MM-dd or yyyy-MM-dd hh:mm:ss |
7 |
FirstName |
Contact’s first name |
No |
Max 50 chars |
8 |
LastName |
Contact’s last name |
Yes |
Max 50 chars |
9 |
Address1 |
Primary address |
No |
Max 256 chars |
10 |
Address2 |
Secondary address |
No |
Max 256 chars |
11 |
City |
City name |
No |
Max 64 chars |
12 |
State |
State/province code |
No |
Max 3 chars |
13 |
PostalCode |
ZIP/postal code. Do not include ZIP+4. |
No |
5, 9, or 6 digits (US/Canadian) |
14 |
Zip4 |
ZIP+4 extension |
No |
Max 4 chars |
15 |
CompanyName |
Company/organization name |
No |
Max 200 chars |
16 |
CompanyTitle |
Job title at company |
No |
Max 50 chars |
17 |
County |
County name |
No |
Max 25 chars |
18 |
Country |
Country name |
No |
Max 50 chars |
19 |
HomePhone |
Home phone number |
No |
Max 20 chars |
20 |
WorkPhone |
Work phone number |
No |
Max 20 chars |
21 |
MobilePhone |
Mobile phone number |
No |
Max 20 chars |
22 |
Fax |
Fax number |
No |
Max 20 chars |
23 |
Email address |
No |
Max 80 chars |
|
24 |
CountryCode |
2-character country code |
Yes |
Exactly 2 chars (e.g., “US”, “CA”) |
25 |
DealerIds |
Internal Aimbase Dealer Identifier |
No |
Max 100 chars |
26 |
DealerNumber |
Primary dealer number |
No |
Text |
27 |
DealerLocation |
Dealer location identifier |
No |
Text |
28 |
ProductIds |
Internal Aimbase Product Identifier |
No |
Max 100 chars |
29 |
ProductCode |
Primary product code |
No |
Text |
30 |
ProductModelYear |
Model year of product |
No |
Text |
31 |
SessionData |
Session tracking data |
No |
Text |
32 |
TriggeredSend |
Triggered send identifier |
No |
Max 100 chars |
33 |
OptInListIds |
Comma-separated list IDs |
No |
Max 100 chars |
34 |
EmailRefused |
Email opt-out status |
No |
“YES”, “NO” |
35 |
Comment |
Additional comments |
No |
Max 2048 chars |
36 |
SendLead |
Whether to send lead |
No |
Text (Y, N) |
37 |
LeadApiIdentifier |
Unique API identifier |
No |
Max 100 chars |
38 |
OptIn |
Communication consent |
Yes |
“YES”, “NO” |
39 |
OptInDate |
Date of consent |
No |
YYYYMMDD format |
40 |
OptInIp |
IP address of consent |
No |
Max 50 chars |
41 |
OptInSource |
Source of consent |
No |
Max 50 chars |
42 |
SendAutoresponder |
Enable autoresponder |
Yes |
“YES”, “NO” |
43 |
SendNurture |
Enable nurture campaigns |
Yes |
“YES”, “NO” (default: YES if not “NO”) |
44 |
SubscriberStatus |
Email subscriber status |
No |
Max 50 chars (deprecated) |
45 |
DealerTypes |
Dealer type classifications |
No |
Max 100 chars |
46 |
SMSOptIn |
SMS consent status |
No |
“YES”, “NO” |
47 |
Program |
Lead sharing program identifier |
No |
Max 64 chars |
48 |
DeliveryOption |
Delivery method preference |
No |
Max 64 chars |
49 |
Referrer |
Referring URL or source |
No |
Max 2048 chars |
50 |
LangCode |
Prospect's preferred language |
No |
Language codes are ISO 639-1 ("en", “fr”, “es”, etc.) |
Custom Fields
Custom fields must: - Be positioned after all required and optional fields - Have names prefixed with X__ or x__ - The prefix is removed when stored (e.g., X__CustomField becomes CustomField) - Empty custom field values are ignored.
Validation Rules
Postal Code Validation
- Must be 5 digits (US ZIP)
- Must be 9 digits (US ZIP+4)
- Must be 6 digits (Canadian postal code)
- No spaces or formatting characters allowed
Opt-In Date Validation
- Must be in YYYYMMDD format
- Example: 20240315 for March 15, 2024
Boolean Field Values
Fields like OptIn, SendAutoresponder, SendNurture, SMSOptIn accept: - “YES” / “NO” - “TRUE” / “FALSE” - “1” / “0” - Case insensitive
Required Field Logic
- SendNurture defaults to YES unless explicitly set to “NO”
- CountryCode must be exactly 2 characters
- LastName is required for all leads
- LeadSourceName, LeadTypeName, LeadCategoryName must exist in Aimbase
File Format Requirements
- Header Row: First row must contain field names exactly as specified
- Encoding: UTF-8 recommended
- Delimiter: Comma-separated values (CSV)
Example Header Row
"LeadSourceName","LeadTypeName","LeadCategoryName","LeadCampaignName","Brands","EventName","LeadDate","FirstName","LastName","Address1","Address2","City","State","PostalCode","Zip4","CompanyName","CompanyTitle","County","Country","HomePhone","WorkPhone","MobilePhone","Fax","Email","CountryCode","DealerIds","DealerNumber","DealerLocation","ProductIds","ProductCode","ProductModelYear","SessionData","TriggeredSend","OptInListIds","EmailRefused","Comment","SendLead","LeadApiIdentifier","OptIn","OptInDate","OptInIp","OptInSource","SendAutoresponder","SendNurture","SubscriberStatus","DealerTypes","SMSOptIn","LangCode","Program","X__CustomField1","X__CustomField2"
Error Handling
The parser will reject files with: - Incorrect number of required fields - Invalid postal code formats - Invalid opt-in date formats - Custom fields without proper X__ prefix - Missing required field values