Overview:
Aimbase offers cross-platform integration with other popular CMS and Automation tools through Zapier. The Zapier Aimbase integration will allow users to authenticate with and submit leads to Aimbase without the use of the Aimbase API, which is required for lead. The following guide includes a walkthrough on how to set up Aimbase lead submission through the Aimbase Zapier Zap.
Map Aimbase Zap Fields:
1. Now that you have completed the authentication step, you should see the "Set up action" screen. This will contain all the fields from Aimbase which can be paired to fields from your App set up in previous steps. The "Test Trigger" from the App setup should give you examples of each data field type to be paired with each Aimbase field.
The following fields are REQUIRED or available to map to submit a lead successfully with tracking data. Some are standard formats that can submit text/strings. Others are fields with values set up in Aimbase directly and can only be submitted using values set up in Aimbase.
| Field Name | Required | Format | Description |
|
FirstName |
Max Length: 50 |
||
|
LastName |
Max Length: 50 |
||
|
Email |
Max Length: 80 |
It is recommended there is validation for email syntax on this field |
|
|
HomePhone |
Max Length: 20 |
||
|
WorkPhone |
Max Length: 20 |
||
|
MobilePhone |
Max Length: 20 |
||
|
Address1 |
Max Length: 64 |
||
|
Address2 |
Max Length: 64 |
||
|
PostalCode |
Max Length: 10 |
||
|
Zip4 |
Max Length: 4 |
||
|
City |
Max Length: 64 |
||
|
County |
Max Length: 25 |
||
|
Country |
Max Length: 50 |
Country name. |
|
|
State |
Max Length: 3 |
State or Province code. |
|
|
CountryCode |
X | Max Length: 2 |
Aimbase accepts the ISO two-letter country codes |
|
Comment |
Max Length: 2048 |
||
|
LeadDate |
YYYY-MM-dd ±hh:mm |
If no lead date is given, the lead’s lead date will be the date and time the lead was submitted to the API. Optionally can provide DateTime Offset. Aimbase will convert to Central Time. DateTime Offset passed should account for daylight savings time. Format: YYYY-MM-dd ±hh:mm. |
|
|
LeadTypeName |
X |
Max Length: 50 |
This value is set up in Aimbase on the Lead Types screen. The URL for this screen is https://<UrlSubdomain>.aimbase.com/Marketing/LeadType. The "Code" column will contain values for this field. This value can contain spaces and capital letters and use them as displayed in Aimbase. NOTE: If the value of this field is submitted and does not match an Aimbase code under Lead Types, then the lead will not be submitted. |
|
LeadCategoryName |
X | Max Length: 50 |
This value is set up in Aimbase on the Lead Category screen. The URL for this screen is https://<UrlSubdomain>.aimbase.com/Marketing/LeadCategory. The "Code" column will contain values for this field. This value can contain spaces and capital letters and use them as displayed in Aimbase. NOTE: If the value of this field is submitted and does not match an Aimbase code under Lead Category, then the lead will not be submitted. |
| LeadSourceName | X | Max Length: 50 | This value is set up in Aimbase on the Lead Source screen. The URL for this screen is https://<UrlSubdomain>.aimbase.com/Marketing/LeadSource. The "Code" column will contain values for this field. This value can contain spaces and capital letters and use them as displayed in Aimbase. NOTE: If the value of this field is submitted and does not match an Aimbase code under Lead Sources, then the lead will not be submitted. |
| LeadCampaignName | Max Length: 50 | A valid Lead Campaign’s Name in the system. | |
|
EventName |
Max Length: 50 |
Free text field. |
|
| Brands | X | Max Length: 100 | This is a value set up in Aimbase on the Manufacturer screen after logging into Aimbase. The URL for this screen is https://<UrlSubdomain>.aimbase.com/Manufacturer. The "Code" column will contain values for this field. NOTE: If the value of this field is submitted and does not match a Brand code under the Manufacturer grid view, then the lead will not be submitted. If no brand value is provided, the lead will be assigned to all of the manufacturer’s brands. |
|
ProductCode |
Max Length: 50 |
The product code. |
|
| ProductName | Max Length: 100 |
The name of the product. |
|
| ProductModelYear | Number, 1000-9999 |
The model year of the product. |
|
| DealerName | Max Length: 80 |
The name of the dealership. |
|
| DealerNumber | Max Length: 20 |
The main part of the unique identifier for dealers. |
|
|
DealerLocation |
Max Length: 20 | The second part or sub number of the unique identifier for dealers. |
|
|
Custom |
A list of custom fields and their values. If the field name is defined as a custom field in the application, the value will be set for that field. If the field name is not defined as a custom field in the application, the field name and value will be added to the lead’s generic metadata values. |
||
|
UserUid |
Guid |
This is an ID that is generated by the Aimbase Web Session Tracking script. This is not a required field but is RECOMMENDED to get full Web Session data for each lead submission. NOTE: Please check with the client if they require this functionality as part of their lead capture. If so, implementation documentation can be found here: https://ws.aimbase.com. |
|
|
SessionUid |
Guid |
This is an ID that is generated by the Aimbase Web Session Tracking script. This is not a required field but is RECOMMENDED to get full Web Session data for each lead submission.. NOTE: Please check with the client if they require this functionality as part of their lead capture. If so, implementation documentation can be found here: https://ws.aimbase.com. |
|
|
Medium |
Max Length: 200 |
UTM parameter for Medium. This parameter reflects the channel name. |
|
|
Term |
Max Length: 200 |
UTM parameter for Term (also known as Keyword). This parameter can be used to pass any characteristics that prompted your content to display. |
|
|
Content |
Max Length: 200 |
UTM parameter for Content. This parameter passes details about your content and can be used to differentiate links that point to the same URL. |
|
|
ProspectExternalId |
Max Length: 20 |
||
|
ExternalId |
Max Length: 50 |
The unique identifier for a lead that matches a unique identifier in an external system. Can be referenced in additional APIs to identify a lead back to an external system. |
|
|
IsCommunicationOptIn |
X | Boolean |
This value is required and needs to be passed as a boolean of "true" or "false,” and cannot be blank. A flag for identifying if the lead is opted in for future communications. |
|
SMSOptIn |
Boolean |
If collecting SMS opt in information, this field should be used to collect the information. |
|
|
SendLead |
Y or N |
An override for if the assigned dealer or contact should be notified of the lead when it is created. | |
| Send to SalesDriver | |||
|
SendAutoresponder |
Boolean |
The flag for opting in or out of sending the Lead an Autoresponder notification after submitting a lead. |
|
|
SendNurture |
Boolean |
The flag for opting in or out of sending the lead nurture email notifications. |
|
|
LeadReroute |
Boolean |
When set to true, it allows the lead to reroute even for a pre-selected dealer. When set to false, it will override any reroute rules in place and lead will not be rerouted. If no value is passed, the default behavior will reroute the lead if the application has the reroute feature turned on. |
|
|
CommunicationOptInIpAddress |
Max Length: 20 |
The IP Address of the lead when it was submitted. This field is required if IsCommunicationOptIn is true. |
|
|
CommunicationOptInDate |
yyyy-MM-dd |
The date the lead opted in for communications. This field is required if IsCommunicationOptIn is true. |
|
|
CommunicationOptInSource |
Max Length: 50 |
The source of the lead that was opted in for communications. This field is required if IsCommunicationOptIn is true. |
|
| Program | string | The OEM program the lead is tied to - not every lead is tied to a program. | |
| CompanyName | Max Length: 50 | ||
| Fax | Max Length: 20 | ||
|
EmailRefused |
Max Length: 5 |
True/False. Notes if the lead should be opted out of email communications. If no value is given, the lead is not opted out of email communications. |
|
| LeadApiIdentifier | Max Length: 100 | Unique value used during an API messaging even to relate a request with a response. This value is not saved with the lead. | |
| ConditionCode | A code that identifies if the product is New (N), Used (U) or Showroom (S). | ||
|
ScoreProspect |
Boolean |
An override for if the lead’s score should be added to the prospect’s score. Default to TRUE if empty. |
|
|
ListCodes |
Max Length: 128 |
Specifies the list codes that the lead should filter into, must match the list codes in Aimbase. |
|
|
Campaign |
Max Length: 50 |
UTM parameter for Campaign. This parameter identifies your campaign. | |
|
Source |
Max Length: 50 |
UTM parameter for Source. This parameter is generally used to pass where the traffic originated. |
Testing Lead Submissions:
- To test your lead submissions, use the Aimbase Username and Password provided to you to log into the Aimbase user interface. The user interface login can be found at https://<Subdomain>.aimbase.com.
- From the Aimbase user interface, use the top navigation and click on the "Leads" screen. Below you will see another option to "View". Here you will be presented with a list of leads recently submitted to the interface.
- More about how to use the Aimbase lead interface can be on this site at: https://help.gorollick.com/73711-leads.