Insert a new lead into the Noojee Campaigner. Lead data is to be POSTed and encoded as json.
Entry point:
http://<server host>/servicemanager/rest/CampaignAPI/insertLead
Parameters:
Parameter | Description |
fTemplateId | Campaign Template id of the Template that the lead will be associated with. |
fCampaignId | Campaign id of the Campaign that the lead will be associated with. |
fAllocationId | Allocation id of the Campaign that the lead will be associated with. |
allowDuplicates | If true checking for duplicate phone numbers will NOT be performed . |
timeStamp | the authentication timestamp. |
hash | the authentication signature or hash. |
System fields that can be part of the json data:
Parameter | Description |
njExternalLeadId | A reference, account number or the like taken from the external data source. Also used to identify lead when updates are made. |
njDisposition | Disposition code. Any Dispositon Actions associated with the new Disposition (via the value in njDispositon) WILL be triggered . |
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 | 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. |
njPriority | A 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. |
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"}' 'http://<server host>/servicemanager/rest/CampaignAPI/insertLead?fTemplateId=41&fCampaignId=41&fAllocationId=38&apiKey=f863246a-973e-11e6-8784-08002718f5b5&allowDuplicates=true'
Sample success response:
{"code":0,"message":"Imported 1 Updated 0 Rejected 0 leads.\n\nErrors (If any):\n Name,State,PostCode,FirstPhone,City,StreetAddress,Error Reason,\n"}