Follow

Understanding the LeadConduit Classic Server Response

If you submit a lead a campaign via HTTP you will receive an XML response from our server. This document describes that response and how to interpret it.

What does the LeadConduit Classic server response tell you?

The response indicates all of the possible outcomes of submitting a lead to a campaign. A response does NOT indicate the final disposition of the posted lead (whether or not you will be paid). That is determined by the final recipient of the lead.

There are several parts to our server response: the result, reason, leadId, and URL. The result will be included in every response, while other parts may be omitted, as appropriate. For a technical description of our response format, please refer to the Document Type Definition (DTD) included in the DOCTYPE declaration of the response (https://classic.leadconduit.com/dtd/response-v2-basic.dtd).

The result tag

A result is shown with every server response. The code word shown inside the result tag indicates the outcome of your lead post:

      

Result Meaning How to Interpret
success lead was submitted successfully We received the lead. Do not resubmit.
queued lead was submitted successfully, but no further processing occurred We received the lead. Do not resubmit.
failure lead was invalid There is a problem with the lead. Do not resubmit without first correcting the problem(s) described in the reason tag(s). Some issues, like a duplicate lead, cannot be corrected.
error the request was malformed (i.e. missing a parameter) There is a problem with your HTTP request. Do not resubmit the same request again without first correcting the problem(s) described in the reason tag(s).

The reason tag(s)

One or more reason tags may be returned in each server response. If there are a several problems with the lead you've posted, each problem will be shown inside its own reason tag. Reason tags are only provided in the event that some problem has occurred (on failure and error responses). Generally speaking, if you submit the same lead again without first correcting these problems, you will receive the same response from our server. For this reason, we require that you do not re-post the same lead that generates a failure or error response without first correcting the problems shown in the reason tags.

The leadId tag

The leadId tag contains our record identifier for the lead you have submitted into LeadConduit. All leads that are posted to our system, regardless of whether the post generates a success or failure response, get a leadId. Generally speaking, if you have a question about a lead you will need to refer to it using the value contained in the leadId tag.

If no leadId tag is provided in the response, the lead could not be created in our system. Sometimes this happens because an error occurs on our end or because the lead-handling component of our system was offline for maintenance. When this happens, you will receive a queued response and no further action is necessary on your part. When our system comes back online, your post will be automatically handled and a new lead will be created in our system. Other times, the problem may be related to the way you posted the lead. You can recognize that this has occurred because an error response is given. Take a look at the specified reason tags to figure out why the lead could not be created in our system.

The url tag

The url tag contains a hyperlink to the lead submitted to a campaign. You can copy and paste this link into your web browser in order to view the details of the lead (you will be required to log into LeadConduit Classic first). The <![CDATA[...]]> information that wraps the hyperlink is included in the url tag for the benefit of software that parses the XML in our response. This is not part of the hyperlink itself.

Some real world examples

  1. A good lead is posted:

  2. An invalid lead. As the reason tags detail, this lead is invalid because it didn't meet the campaign's requirements. Do not resubmit this lead without first correcting the email address and providing the lead's phone number.

  3. A lead posted while LeadConduit Classic is offline. Notice that there is no leadId in the response. The reason tag shows why the lead was queued. The lead will be processed when the system is back online.

  4. The request is missing a required system parameter. As the posting instructions detail, xxAccountId and xxCampaignId (and xxSiteId, in some cases) are required. Leads cannot be handled without those parameters, so no leadId is contained in the response.

Response Versions

LeadConduit Classic's current response is in its second version, "v2". The first response version ("v1") has been phased out. This document is a reference for the v2 response only. More information about our v1 response is available upon request. Each campaign's posting documents, available within LeadConduit Classic, reflect the v2 response format. While some older campaigns may still be operating with the v1 response, it is strongly recommended to update these to the newer and much improved v2 posting process.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

You must be logged in to comment.