Api Function Name

zoho_insert_lead


This function will take a lead generated from various sources such as facebook ads, gravity forms and general forms and insert that lead into the “lead approval” system in the Zoho CRM system.

OBSERVATIONS

    1. When anĀ  api key is successfully passed to our api, we do a dealer lookup to get the core dealer id assigned to the api key. This allows us to add the core dealer id to the ZOHO record so the lead can be mapped back to its origin.
    2. After the lead is sent to zoho we also store a copy of the lead within the core dealer system so we have a record of leads generated by the dealers api key.
    3. If you are a dealer and have your own web site and wish for the leads to be inserted to ZOHO from your web site, then we recommend using the “web hook using POST function” provided by Zapier. For this you will need an API key from us, please contact support@dealerpanel.com for an api key.
    4. As per Jody G on 16th of July 2018, the email field is not required as in some lead generation campaigns only the phone number is grabbed therefore nulling the requirement for email.

IMPORTANT
Each source of leads must send its own unique api key so that we can track the requests, therefore contact the api manager at support@dealerpanel.com for a key BEFORE sending api requests otherwise we cannot map leads to the dealership.

Updates
16th March 2020 – we have added a function for checking the description field for banned words. This uses the following api: spam_check and we added response code 13004 to handle any spams. In case of missing emails marked as spam, you will need to check the email account leads.backup@dealerpanel.com as this api will NOT inform anyone of spams.

10th April 2020 – we have added an extra function now to track the Darcy crazy SMS forms. We have added sms_messages_tracking API to track the sent messages so they can be traced back to the dealer cost centres. We have also put in the clickatell HTTP api for sending messages to clickatell.

4th of June 2020 – we have integrated the get_closest_dealer api into the insert process so that the head fofice can quickly see the closest three dealers to the lead.

End Point URL

The url end point is: https://api.arcticspascore.com/live/

Parameters

action Type Example Required Description
action varchar zoho_insert_lead yes

Name of the api function

first_name varchar Joe

First name of the lead

NOTE REGARDING FULL NAMES:
In the case you are grabbing only the FULL NAME of the lead, you only need to pass the full name to the first_name field.

On the api side we will "SPLIT" the name into first and last name so both fields are populated.

Why?

Zoho requires a last name so if no last name is passed then the insert will fail, so when we receive the first_name data and last_name we will try and split the full name across the two fields so Zoho will be happy.

last_name varchar Bloggs

Last name of the lead

email varchar joe@bloggs.com

Email address of the lead

tel varchar 999888777

Telephone number of the lead.

Try and pass the full phone number including INT code if possible.

However, if you are passing ip parameter, we will do a country lookup anyway.

tel_for_sms varchar 1555666777

This should be a number to where the sms message will be sent to. This will be a dealers mobile number. NOTE: MUST INCLUDE INT CODE WITHOUT 00.

street varchar 1 Acme Way

This will be the street address for the lead.

city varchar Acmeville

This will be the city name for the lead.

state varchar AcmeState

The state/region for the lead

zip_code varchar 19958

The zip code of the lead.

country varchar Canada

The country name of the lead.

NOTE: if you do not pass country but pass the ip then we will do a ip lookup and establish the country name from the IP.

ip varchar 255.255.255.255

This will be the IP of the lead.

If you pass the ip, we will do a country lookup to get some details of the api and pass those details to the zoho and core system

request_type varchar General Enquiry

This is a free text field for you to enter what type of request it is.

EG: General Enquiry or Support Question

source varchar Some web site

Enter a free text reference so we know where the lead was generated from.

source_dealer_domain varchar dealerurl.com

If this lead is from a dealer site or needs to be associated with a dealer site, then pass the BASE DOMAIN name, IE: not http:// or https:// or www. Pass only the domain name.

We use this domain name to compare it with the domains sitting in the dealer core system.

source_url varchar https://domain.com/form

An ABSOLUTE URL where the lead was generated.

For example if the lead is embedded in a form, pass the url of where the lead is embedded.

dealer_id varchar 1234

This will be the dealer id of the dealer in the dealer core system

description varchar Long runs the fox

This is a free text section which will be shown in the description field inside of the Zoho lead detail.

This can contain for example any comments or questions/requirements from the customer.

Response Codes

Response Code Response Message
13000 null response code
13001 error connecting to zoho api
13002 zoho api returned an error (we will provide custom message from zoho)
13003 lead inserted successfully

Example Responses

Response Code Response Format Example
13002 json
{
    "MainResponse": {
        "APIName": "Arctic Spas Core Live API",
        "APIFunctionName": "zoho_insert_lead",
        "HttpResponseCode": 200,
        "RequestID": 255640,
        "QueryDateTimeGMT": "2018-07-13 16:46:27",
        "ResponseTime": 0.793669939041,
        "ResponseCode": "13002",
        "ResponseMessage": "Zoho error code: 4834. Zoho error message: Invalid Ticket Id"
    }
}
13003 json
{
    "MainResponse": {
        "APIName": "Arctic Spas Core Live API",
        "APIFunctionName": "zoho_insert_lead",
        "HttpResponseCode": 200,
        "RequestID": 255643,
        "QueryDateTimeGMT": "2018-07-13 16:47:04",
        "ResponseTime": 1.0912361145,
        "ResponseCode": "13003",
        "ResponseMessage": "lead inserted successfully"
    }
}
13004 json
{
    "MainResponse": {
        "APIName": "Arctic Spas Core Live API",
        "APIFunctionName": "zoho_insert_lead",
        "HttpResponseCode": 200,
        "RequestID": 960332,
        "QueryDateTimeGMT": "2020-03-16 15:29:32",
        "ResponseTime": 0.726047039032,
        "ResponseCode": "13004",
        "ResponseMessage": "banned words detected"
    }
}