Versions Compared

Key

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

...

Parameters:

ParameterDescriptionRequired
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

Yes
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.

Yes
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.

Yes
allowDuplicatesIf true checking for duplicate phone numbers will NOT be performed .No
apiKeyapi key provided by Noojee SupportYes


System fields that can be part of the json data:

ParameterDescriptionRequired
njExternalLeadIdA reference, account number or the like taken from the external data source. Also used to identify lead when updates are made.No
njCallBackDate

The date and 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.

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
njContactHoursSets the Contact Hours for the lead. If not passed the lead will default to the Campaign Templates default Contact Hours.No

Syntax

The format of the data posted is a json array containing one or more sets of name value pairs:

Code Block
[{"fieldname1": "lead 1 field 1 value", "fieldname2" , "lead 1field 2 value"}, {"fieldname1": "lead 2 field 1 value", "fieldname2" , "lead 2 field 2 value"}, {"fieldname1": "lead 3 field 1 value", "fieldname2" , "lead 3field 2 value"}]

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"}
, {"Name":"John Smith","StreetAddress":"Suite 9/10 Main St", "City": "Yarravile", "State":"Vic", "PostCode":"3000", "FirstPhone":"0383218100"}]' 
'https://<server host>/servicemanager/rest/CampaignAPI/insertLeads?fTemplateId=41&fCampaignId=41&fAllocationId=38&apiKey=f863246a-973e-11e6-8784-08002718f5b5&allowDuplicates=true'

...