Creating Leads

Last updated
Save as PDF

Introduction

Posting to SecurityTrax is done via raw http post. With this information you will be able to send leads directly into the system in real-time. The XML described below should be sent as it appears (with the correct data of course). If you do not wish to send specific optional fields, please do not erase the field completely but rather leave it blank. In order to perform this action you will need the following information:

URL	https://secure.securitytrax.com/site...eadpostxml.php
source_id	Required. This is the unique ID that SecurityTrax assigns to the partner company. Source ID Provided by the company using SecurityTrax.
fname	Required. The first name of the lead/
lname	Required. The last name of the lead.
address1	First line of the lead's address.
address2	Second line of the lead's address.
city	Required. City of the lead.
state	Required. State of the lead. Must be 2 letter state code.
zip	Zip code of the lead. Only numbers, no hyphens etc.
phone1	Required. The primary phone number of the lead. Numbers only.
phone2	Cell phone number of the lead. Numbers only.
phone3	Work phone number of the lead. Numbers only.
phone4	Other phone number of the lead. Numbers only.
email	Email address of the lead.
lead_comments	Any comments originating from the lead.
contact_time	Any textual representation of the best time to contact the lead. Limit 50 characters.
lead_source_info	Information regarding the source of the lead.
lead_company_unique_id	Unique ID of the lead in the sender's system.
lead_home_ownership	Ownership state of the home to the lead. Possible values are: own => The lead owns the home rent => The lead is renting the home lease => The lead has a lease on the home other => Any other scenario
lead_callcenter_rep	The name/ID of the Rep in the sender's system who generated the lead.
lead_callcenter_notes	Any notes specific to this lead from the sender.
lead_promo_code	The promotion code (from the sender's perspective) used to generate this lead.
lead_custom1	Custom text field.
lead_custom2	Custom text field.
lead_custom3	Custom text field.
lead_custom4	Custom text field.
spouse	Name of the lead's spouse.
lead_rep_id	The ID of the rep in the receiver's system who the lead will be automatically assigned to.
campaign_id	Sub ID to the source_id.
lead_type_id	Used as a manual override to the receiver's default settings. Possible valuse are: 2 => Pending 3 => Queue
lead_purchase_price	Price the receiver will pay for the lead. Should be a numeric value without $ in form XX.YY

Sample Request

The following is an example of a valid request.

<?xml version="1.0" standalone="yes"?>
<leads>
	<lead>
		<source_id>Partner ID</source_id>
		<campaign_id/>
		<lead_type_id/>
		<lead_purchase_price>27.50</lead_purchase_price>
		<fname>Sue</fname>
		<lname>Stallman</lname>
		<address1>290 Market Road</address1>
		<address2/>
		<city>Notus</city>
		<state>ID</state>
		<zip>83660</zip>
		<phone1>8013127735</phone1>
		<phone2>8013678735</phone2>
		<phone3>8013674735</phone3>
		<phone4>8013679735</phone4>
		<email>goodgrillz@myemail.net</email>
		<lead_comments>I am looking for quotes and ready to buy!</lead_comments>
		<contact_time>Noon</contact_time>
		<lead_source_info>Cold Call</lead_source_info>
		<lead_company_unique_id>00001A321</lead_company_unique_id>
		<lead_home_ownership>rent</lead_home_ownership>
		<lead_callcenter_rep>Joe Rogers</lead_callcenter_rep>
		<lead_callcenter_notes>They are very interested</lead_callcenter_notes>
		<lead_promo_code>ABCDE</lead_promo_code>
		<lead_custom1>this is custom1</lead_custom1>
		<lead_custom2>this is custom2</lead_custom2>
		<lead_custom3>this is custom3</lead_custom3>
		<lead_custom4>this is custom4</lead_custom4>
		<spouse>Mary</spouse>
		<lead_rep_id/>
	</lead>
	<lead>
		<source_id>1</source_id>
		<campaign_id/>
		<lead_type_id>2</lead_type_id>
		<lead_purchase_price>25.00</lead_purchase_price>
		<fname>Mike</fname>
		<lname>Smith</lname>
		<address1>28590 Market Road</address1>
		<address2>Suite 2</address2>
		<city>Parma</city>
		<state>ID</state>
		<zip>83660</zip>
		<phone1>8013677735</phone1>
		<phone2>8013678735</phone2>
		<phone3>8013674735</phone3>
		<phone4>8013679735</phone4>
		<email>msmith@myemail.net</email>
		<lead_comments>Please call soon</lead_comments>
		<contact_time>Noon</contact_time>
		<lead_source_info>Google Adwords - ABC Security</lead_source_info>
		<lead_company_unique_id>0000122322</lead_company_unique_id>
		<lead_home_ownership>rent</lead_home_ownership>
		<lead_callcenter_rep>Joe Rogers</lead_callcenter_rep>
		<lead_callcenter_notes>They are very interested</lead_callcenter_notes>
		<lead_promo_code>ABCDE</lead_promo_code>
		<lead_custom1>this is custom1</lead_custom1>
		<lead_custom2>this is custom2</lead_custom2>
		<lead_custom3>this is custom3</lead_custom3>
		<lead_custom4>this is custom4</lead_custom4>
		<spouse>Mary</spouse>
		<lead_rep_id/>
	</lead>
</leads>

Sample Response

Here you are looking for success="true" attribute of the response node. If success="false" then you will have 1 or many error nodes inside data node.

div class="code">

<?xml version="1.0"?>
<root>
	<responses>
		<response success="true">
			<data>
				<fname>testfirst</fname>
				<lname>testlast</lname>
				<customer_id>1003</customer_id>
			</data>
		</response>
 	</responses>
</root>