LeadConduit by ActiveProspect

Duplicate Check Service API


  

The RESTful LeadConduit Duplicate Check Service API is implemented as XML over HTTP using POST.  The GET, PUT, and DELETE verbs are unused.  This service allows you to determine, prior to actually posting a lead to LeadConduit, whether the lead will be marked as a duplicate.

Authentication

This API is anonymous, meaning that anyone can check if a lead will be a duplicate provided that they use the correct parameters in the API call.

Usage

To test whether a lead will be marked as a duplicate, POST the lead data and your Node ID to https://app.leadconduit.com/duplicates.xml.  Minimally, the primary key value(s) and the xxNodeId parameter are required.  For example, if you wanted to test for a duplicate in a campaign with the "email" field as the primary key and where your Node ID is ABC123, you might issue the following command using the curl utility:

curl -X POST -d 'xxNodeId=ABC123&email=test@test.com' https://app.leadconduit.com/duplicates.xml

If there is a duplicate, you would get the following response.  As you can see, the response contains one <lead_id/> element for each duplicate lead found. 

<?xml version="1.0" encoding="UTF-8"?>
<duplicates>
     <lead_id>12345</lead_id>
     <lead_id>45678</lead_id>
</duplicates>

If no duplicates are found, you would get the following response:

<?xml version="1.0" encoding="UTF-8"?>
<duplicates/>

Not guaranteed

The duplicate check API can only tell you whether a lead is a duplicate as of the moment the call to the duplicate check API was made.  If another lead is posted to the system between your call to the duplicate check API, and your call to post the lead into LeadConduit, your lead will be marked as a duplicate.  Because of this, the API does cannot guarantee that your lead will not be a duplicate.

Primary Keys

If a campaign uses multiple primary keys, then you must provide parameter values for all of the primary key fields.  A missing or empty primary key parameter will cause the lookup to fail.

Errors

If you fail to provide the required parameters, the API will return an HTTP 400 and the response body will contain a message about which parameter is missing.  If the xxNodeId is invalid, then the API will respond with an HTTP 404.  Note that the xxNodeId parameter is case sensitive. Sending the parameter xxnodeid or xxNodeID will cause an error.

 

Tags:
last updated 2/17/2010 5:34 PM