Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note: this method is deprecated. Use UpdateLeadFast.

Update an existing lead in the Noojee Campaigner. Lead data is to be POSTed and encoded as json.

...

Code Block
linenumberstrue
httphttps://<server host>/servicemanager/rest/CampaignAPI/updateLead


Parameters:

ParameterDescription
fTemplateId

Campaign Template id of the Template that the lead will be associated with.

See 16.0 Get Campaign Template List to obtain Template Id's

fCampaignId

Campaign id of the Campaign that the lead will be associated with.

See 17.0 Get Campaign List to obtain a list of campaign Id's.

fAllocationId

Allocation id of the Campaign that the lead will be associated with.

See 18.0 Get Allocation List to obtain a list of allocations.

timeStamp
njExternalLeadId
the authentication timestampthe authentication signature or hash.
Used to identify the lead to be updated.
hash
apiKeyapi key provided by Noojee Support


System fields that can be part of the json data:

ParameterDescription
njExternalLeadIdUsed to identify the lead to be update.The time on which the lead is to be called. If not specified the lead is treated as a 'new' lead and will be called on a first come first served basis. Mandatory if njCallBackDate is supplied.
Required
njDispositionDisposition code. Any Dispositon Actions associated with the new Disposition (via the value in njDispositon) WILL be triggered .Yes
njCallBackDate

The date on which the lead is to be called. If not specified the lead is treated as a 'new' lead and will be called on a first come first served basis.

njCallbackTime

Format is "yyyy/MM/dd HH:mm"

No
njPriorityA priority between 0 and 100. The lower the number the higher the priority. Higher priority leads will be called before lower priority calls. Default priority is 10.No
Phone NumberWhilst not a system field, you MUST specify at least on of the phone fields. However if you don't want to change the existing field value you can simply pass the value '<No Change>' as the value for any phone field. Note: the angle brackets '<>' are required.Yes



Sample query:

Code Block
linenumberstrue
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", "njExternalLeadIdSecondPhone":"9856<No Change>", "njDisposition":"Sale"}' 'httphttps://127.0.0.1:8080/servicemanager/rest/CampaignAPI/updateLead?fTemplateId=41&fCampaignId=41&fAllocationId=38&njExternalLeadId=9856& apiKey=f863246a-973e-11e6-8784-08002718f5b5'

...