create_leadCreates a new lead in the CRM.
Example Request:
https://jason.apogeegate.com/aicore/backbone/service?ai_login_id=apiuser&ai_login_password=APIuser123&ai_command=create_lead&first_name=John&last_name=Doe&address=123 Test Street&city=Test City&state=Test State&zip=97303&country=Test Country&phone=132-123-1234&followup_date=2010-01-01 12:00:00&besttime=Morning&status=1
&priority=Warm&email=example@example.com&govt_id=100-10-1000&source=example.com&tag_append=prospect,new¬es=[{"status":"Message","Notes":"test"},{"status":"Email","Notes":"example@example.com"}]
Example Response:
https://yourwebsitedomain.com?status=0&status_message=Lead Creation Successful&lead_id=1001
| Name | Type | Required | Example |
|---|---|---|---|
first_name | String | N | JohnFirst name of lead |
last_name | String | N | DoeLast name of lead |
company | String | N | Example CompanyCompany of lead |
address | String | N | 123 Test StreetLead address |
address_2 | String | N | 123rd AveLead address second line |
city | String | N | Test CityLead city |
state | String | N | Test StateLead state |
zip | Integer | N | 97303Lead Postal Code |
country | String | N | Test CountryLead Country |
phone | String | N | 132-123-1234Lead Phone Number |
cell | String | N | 321-321-4321Lead Mobile Number |
ok_to_text | String | N | Y/NOK to text this lead? |
fax | String | N | 213-213-4231Lead Fax Number |
skype | String | N | johnsmith100Lead Skype Username |
ip | String | N | 123.123.123.123Lead IP Address |
followup_date | DateTime | N | 2010-01-01 12:00:00Next follow up date for lead |
besttime | String | N | MorningBest time to follow up with lead |
status | Integer | N | 1Comment this to direct them to the status TE page TODO |
priority | String | N | WarmHow important the lead is |
custom_status | Integer | N | 0Comment this to direct them to the custom status TE page http://jason.apogeegate.com/aicore/backbone/lead_management_custom_statuses |
gmt_offset | Integer | N | -1000Lead's time zone |
email | String | N | example@example.comLead Email address |
admin_notes | String | N | Note text for adminsNotes viewable by admins |
govt_id | Integer | N | 100-10-1000Lead government id |
source | String | N | example.comLead source |
sub_id | String | N | 10Affiliate sub id |
sub_id2 | String | N | 11Second Affiliate sub id |
external_id | String | N | 100Lead external id |
birth_date | Date | N | 1980-01-31Lead's date of birth (YYYY-MM-DD or MM-DD) |
insert_conflict | String | N | ErrorThere are 4 types of conflict resolution Error(default) will just have any conflicts return an error message, overwrite will just overwrite any conflicts with the new data, update will update the data that is conflicting with the insert, and duplicate which will just make a new row |
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,tag3This will add a set of tags to the lead |
ownerID | String | N | 12The userID of the user by which this lead will be owned |
pool | String | N | billmoreA Pool Name to which this lead belongs |
| Name | Type | Example |
|---|---|---|
status | Integer | 0 |
status_message | String | Lead Creation Successful |
lead_id | Integer | 1001 |