Update an existing lead in Noojee Contact.

The timing of when the lead will be dialed depends on the normal lead prioritisation mechanism (priority, callback date, balance mode etc) however the lead won't be considered until the next dialer cache refresh occurs. Cache refreshes occur every two minutes, so on average, injected leads will take at least one minute before they will be considered for dialing.

As the UpdateLeadFast end point allows you to set a disposition, a lead may in fact never by dialed as you can close a lead out using the appropriate disposition.

The endpoint UpdateLeadFast replaces the original UpdateLead method. The new endpoint takes the same arguments but has enhanced error codes and as the name implies is faster than the original UpdateLead endpoint.

Performance considerations

Injection of leads into Noojee Campaigner is a 'heavy weight' process (it can take a long time) as each lead needs to be found, validated and updated.

In order to protect the core function of the PBX the end point is rate limited. The api allows multiple concurrent calls limited to (No. of hardware threads / 2) and each call we never complete in less than 100 ms. On larger databases the time required to complete each update may increase further.

Note: the rate limiting is across both the UpdateLeadFast and InsertLeadFast combined.

If you exceed the above rates, the system will queue additional requests. This may result in your call to the endpoint timing out (currently timeout is 1 minute). If your call to the InsertLead endpoint times out, then the lead will not be updated and you will need to retry the update.

Queue insertions

As the end point is rate limited we strongly recommend that you queue the updates within your system and include retry logic for when the update fails. This will deal with the above rate limiting logic as well as provide guaranteed delivery even if the Noojee PBX goes down for maintenance.

Retries

You must expect calls to UpdateLeadFast to fail so make certain your code can retry the action. If an update fails then wait a couple of minutes before retrying.

Entry point:

Lead data must be POSTed and encoded as json.

https://<server host>/servicemanager/rest/CampaignAPI/updateLeadFast

URL Parameters:

System fields that can be part of the json data:

Sample query:

curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST 
-d '{"Name":"Jane Smith","StreetAddress":"Suite 8/10 Hoddle St", "City": "Abbotsford"
, "State":"Vic", "PostCode":"3064", "FirstPhone":"0383218199", "SecondPhone":"<No Change>"
, "njDisposition":"Sale"}' 
'https://127.0.0.1:8080/servicemanager/rest/CampaignAPI/updateLeadFast?fTemplateId=41&fCampaignId=41
&fAllocationId=38&njExternalLeadId=9856& apiKey=f863246a-973e-11e6-8784-08002718f5b5'

Sample success response:

{"code":0,"message":"OK"}

Error Codes

The API returns a HTTP status code and an json error code as follows:

HTTP status of 200 is returned when the lead was successfully inserted or updated.

HTTP status of 400 is returned when you passed some invalid data.

HTTP status of 500 is returned if our system throws an exception (our code is broken).