CRM Service Documentation

Name	Type	Required	Example
`mode`	String	Y	`insert/update` 'insert' or 'update' - if mode is 'update' then 'lead_id' or 'external_id' is required
`lead_id`	String	N	`123456` Lead id to update
`external_id`	String	N	`ABC123456` Lead external id to update (or may also provide for insert)
`full_name`	String	N	`John Doe` First & Last - script will attempt to separate them
`first_name`	String	N	`John` First name of lead
`last_name`	String	N	`Doe` Last name of lead
`company`	String	N	`Example Company` Company of lead
`address`	String	N	`123 Test Street` Lead address
`address_2`	String	N	`123rd Ave` Lead address second line
`city`	String	N	`Test City` Lead city
`state`	String	N	`Test State` Lead state
`zip`	Integer	N	`97303` Lead Postal Code
`country`	String	N	`Test Country` Lead Country
`lat`	Decimal	N	`Latitudinal street address position`
`lng`	Decimal	N	`Longitudinal street address position`
`phone`	String	N	`132-123-1234` Lead Phone Number
`cell`	String	N	`321-321-4321` Lead Mobile Number
`ok_to_text`	String	N	`No` Either "Yes" or "No"
`fax`	String	N	`213-213-4231` Lead Fax Number
`skype`	String	N	`johnsmith100` Lead Skype Username
`ip`	String	N	`123.123.123.123` Lead IP Address
`followup_date`	DateTime	N	`2010-01-01 12:00:00` Next follow up date for lead - auto-creates a followup event when updated
`besttime`	String	N	`Morning` Best time to follow up with lead
`status`	Integer	N	`1` Comment this to direct them to the status TE page TODO
`priority`	String	N	`Warm` How important the lead is
`custom_status`	Integer	N	`0` Integer custom_status or custom_status Text (must already exist in the custom_status table)
`gmt_offset`	Integer	N	`-1000` Lead's time zone
`email`	String	N	`example@example.com` Lead Email address
`admin_notes`	String	N	`Note text for admins` Notes viewable by admins
`govt_id`	Integer	N	`100-10-1000` Lead government id
`source`	String	N	`example.com` Lead source
`sub_id`	String	N	`10` Affiliate sub id
`sub_id2`	String	N	`11` Second Affiliate sub id
`birth_date`	Date	N	`1980-01-31` Lead's date of birth (YYYY-MM-DD or MM-DD)
`note`	String	N	`Bla bla bla` A new note to be appended to the notes section
`notes`	JSON Encoded String	N	`[{"Status":"Message","Notes":"test"},{"Status":"Email","Notes":"example@example.com"}]` Each note needs a status and the content of the notes
`tags`	String	N	`tag1,tag2,tag3` This will set the tags on the lead to exactly this list (missing tags will be removed)
`ownerID`	String	N	`12` The userID of the user by which this lead will be owned
`pool`	String	N	`billmore` A Pool Name to which this lead belongs
`upload_file_name`	String	N	`filename.pdf` Base name of file (without path)
`upload_file_contents`	String	N	`"*#@(!...."` Full contents of the file (keep files small to avoid delays in post time)
`OTHER_CUSTOM_FIELDS`	Misc	N	`...` Other custom fields may be available on a per-system basis (see names of custom field names in edit mode)
`match_update`	Integer	N	`1` Perform matching (Duplicate Scrubbing) and update an existing lead (leave 'mode'='insert')
`match_name_and_address`	Integer	N	`1` Both name+address must match (each match item is ORed with the others)
`match_name_and_phone`	Integer	N	`1` Both name+phone must match (each match item is ORed with the other)

API Service Documentation

Command: `lead_set`

Request

Response

Name	Type	Example
`status`	Integer	`0`
`status_message`	String	`Lead Creation Successful`
`lead_id`	Integer	`1001`

API Service Documentation

Command: lead_set

Request

Response

Command: `lead_set`