CRM Service Documentation

Example Request:

https://jason.apogeegate.com/aicore/backbone/service?ai_login_id=apiuser&ai_login_password=APIuser123&ai_command=update_lead&lead_id=101&first_name=Johnathan&tag_append=prospect,import&notes=[{"status":"Message","Notes":"test"},{"status":"Email","Notes":"example@example.com"}]

Example Response:

https://yourwebsitedomain.com?status=0&status_message=Lead Update Successful

Name	Type	Required	Example
`lead_id`	Integer	Y	`101` Lead ID
`external_id`	String	N	`100` Lead external id - Can be lookup
`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
`phone`	String	N	`132-123-1234` Lead Phone Number
`cell`	String	N	`321-321-4321` Lead Mobile Number
`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
`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` Comment this to direct them to the custom status TE page TODO
`gmt_offset`	Integer	N	`-1000` Lead's time zone
`email`	String	N	`example@example.com` Lead Email address
`admin_notes_append`	String	N	`UPDATE Note text for top-right note section` This will append a new note to the current notes with a date appended for it
`admin_notes_send`	String	N	`SET note text for top-right note section` This will overwrite the notes field
`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)
`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
`tag_append`	String	N	`tag1,tag2,tag3` This will will append new tags to the lead and not overwrite old ones
`tag_send`	String	N	`tag1,tag2,tag3` This will remove all existing tags and replace it with these

API Service Documentation

Command: `update_lead`

Request

Response

Name	Type	Example
`status`	Integer	`0`
`status_message`	String	`Lead Update Successful`

API Service Documentation

Command: update_lead

Request

Response

Command: `update_lead`