The format of the response depends on what Accept header is sent with the request. Both XML and JSON are supported formats.
Success
A Success response body includes:
1. An “outcome” element with value “success”
2. A “lead” element with a sub-element named “id” that includes the lead’s unique LeadConduit identifier.
3. A “price” element with lead pricing if used. This will default to 0 if not configured.
JSON
{“outcome”: “success”,“lead”: {“id”:“55c8e255g56r8d5f2e69e1d9”}, “price”: 0}
XML
<?xml version="1.0"?> <result> <outcome>success</outcome> <reason/> <lead> <id>55c8e255g56r8d5f2e69e1d9</id> </lead> <price>0</price> </result>
Failure or Error
Both a Failure and Error response body include:
1. An “outcome” element with value “failure” or “error”
2. A “reason” element that carries the customer-programmable reason for the failure/error
3. A “lead” element with a sub-element named “id” that includes the lead’s unique LeadConduit identifier.
JSON
{“outcome”:“failure”,“reason”:“Failed email validation”,“lead”: {“id”:“55c8e255g56r8d5f2e69e1d9”},“price”:0}
XML
<?xml version="1.0"?> <result> <outcome>failure</outcome> <reason>Failed email validation</reason> <lead> <id>55c8e255g56r8d5f2e69e1d9</id> </lead> <price>0</price> </result>
Result Key
| Result | Meaning | How to Interpret |
|---|---|---|
| success | lead was submitted successfully | LeadConduit 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). |
HTTP Response Codes
| Result | Meaning | How to Interpret |
|---|---|---|
| 201 | Created | LeadConduit successfully received the lead, independent of the disposition of the lead. |
| 303 | Redirected | The caller can also include the redir_url query string parameter and the response will be an HTTP 303 with the Location header set to that redir_url. Typically one might use this for submitting leads from a form to redirect to a thank you page. |
| 406 | Not Acceptable | The Content-Type was supported but the caller requested an unsupported response format in the Accept header. LeadConduit will receive the lead in this case and will record an error source event. The flow will not process the lead because LeadConduit cannot respond back to the caller using a format that makes sense to the caller. |
| 415 | Unsupported Media Type | An unsupported Content-Type was sent. LeadConduit will receive the lead and will record an error source event, but the flow will not process the lead because the request body cannot be interpreted. |
NOTE: In the event that a different response is returned beyond these listed here, for example, “host not found” this means LeadConduit never received the lead.
Comments
0 comments
Please sign in to leave a comment.