API Service Documentation

Command: update_lead

Updates a lead in the CRM.


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

Request

NameTypeRequiredExample
lead_idIntegerY101

Lead ID

external_idStringN100

Lead external id - Can be lookup

first_nameStringNJohn

First name of lead

last_nameStringNDoe

Last name of lead

companyStringNExample Company

Company of lead

addressStringN123 Test Street

Lead address

address_2StringN123rd Ave

Lead address second line

cityStringNTest City

Lead city

stateStringNTest State

Lead state

zipIntegerN97303

Lead Postal Code

countryStringNTest Country

Lead Country

phoneStringN132-123-1234

Lead Phone Number

cellStringN321-321-4321

Lead Mobile Number

faxStringN213-213-4231

Lead Fax Number

skypeStringNjohnsmith100

Lead Skype Username

ipStringN123.123.123.123

Lead IP Address

followup_dateDateTimeN2010-01-01 12:00:00

Next follow up date for lead

besttimeStringNMorning

Best time to follow up with lead

statusIntegerN1

Comment this to direct them to the status TE page TODO

priorityStringNWarm

How important the lead is

custom_statusIntegerN0

Comment this to direct them to the custom status TE page TODO

gmt_offsetIntegerN-1000

Lead's time zone

emailStringNexample@example.com

Lead Email address

admin_notes_appendStringNUPDATE 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_sendStringNSET note text for top-right note section

This will overwrite the notes field

govt_idIntegerN100-10-1000

Lead government id

sourceStringNexample.com

Lead source

sub_idStringN10

Affiliate sub id

sub_id2StringN11

Second Affiliate sub id

birth_dateDateN1980-01-31

Lead's date of birth (YYYY-MM-DD or MM-DD)

notesJSON Encoded StringN[{"status":"Message","Notes":"test"},{"status":"Email","Notes":"example@example.com"}]

Each note needs a status and the content of the notes

tag_appendStringNtag1,tag2,tag3

This will will append new tags to the lead and not overwrite old ones

tag_sendStringNtag1,tag2,tag3

This will remove all existing tags and replace it with these

Response

NameTypeExample
statusInteger0
status_messageStringLead Update Successful