Leadconduit API Specs

Submission Docs

Overview

These instructions describe how Marketing Mavericks should send leads into Fluent Solar LLC's flow Primary Flow and understand what to expect in response. If you have any questions, please contact your representative at Fluent Solar LLC or email [email protected].

Submission URL

This URL is different for every LeadConduit Flow you post to. You cannot reuse the same URL across Flows or customers.

https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit

Fields

The following fields will be captured by this Flow in LeadConduit. There are no built-in field length limitations. See the Acceptance Criteria for required fields. For examples of how to submit these fields, please see the examples below.

Field Label	HTTP Parameter	Type	Description	Examples
First Name	first_name	first_name	First name	Mike, Robert, Janet
Last Name	last_name	last_name	Last name	Jones, Campbell, Smith
Phone 1	phone_1	phone	First telephone number	5127891111, 512 789-1111, 512-789-1111 x 44, 1 (512) 789-1111
Email	email	email	Email address	[email protected], [email protected], [email protected]
Address 1	address_1	street	The first line of the address	123 Main Street, 4225 Briarcliff Cove, 172 Hawkcrest Lane
Address 2	address_2	string	The second line of the address, often used for apartment or box numbers	Unit C, Box 215, #123
City	city	city	City	Austin, Dallas, Chicago, Paris
State	state	state	State	TX, Texas, Quebec, Île-de-France
Postal Code	postal_code	postal_code	The postal or zip code	78751, 78751-4224, 78751 4224, Q2E 4U7, A11 1AA, AA11A 1AA
TrustedForm Cert URL	trustedform_cert_url	trustedform_url	The URL pointing to this lead's TrustedForm Certificate	https://cert.trustedform.com/a1028cbb41b876744fa752eec276bec0e4c48b33, https://cert.trustedform.com/0.rpM21ddljS9BNNUOm6FZVVqb5C5JMk1cofI4nDGdwy5ezucyxjok9qLyUXMu9diW62Xac8xNMpomBf1B-XDpfbYvaFMr0YC-54TzHcLrni4.OHOMoMFXaX9YW9DoX_xeng.1vnf6DTWU7sJo6XAxlRP_w, https://cert.trustedform.com/11NgkzK_mroUbOD1-x66NigDliU1kdvbaCtLGvyja1K80vU1sKh9grlwP78vzKSp4ncwAfJAlNPNVY8f, https://ping.trustedform.com/0.1JT7QUPI1sOFZxpr72ZK45K0ck75kEBO9H3jNJuX8NkqMTv4UF-zrapBUlsefTP3lkXWh6qM.fF0DNrov0zNUNVRCqDV5dw.E2eYOJ5-dnAgiX02-96FNQ
utility company	utility_company_flu	string		any text
utility bill	utility_bill_flu	string		any text
Credit Rating	credit_rating	string	The consumer's estimated credit rating	excellent, good, fair, poor
tracking ID	tracking_id_flu	string		any text
Phone 2	phone_2	phone	Second telephone number	5127891111, 512 789-1111, 512-789-1111 x 44, 1 (512) 789-1111
Phone 3	phone_3	phone	Third telephone number	5127891111, 512 789-1111, 512-789-1111 x 44, 1 (512) 789-1111
Jornaya Lead Token	universal_leadid	string	Jornaya's 36 Character Universal Lead Token	063A3537-2A60-890C-5F89-D2435448FD1D, 063A3537-2A60-890C-5F89-D2435448FD11
lead price	lead_price_flu	string	How much the lead costs	$10
Office	office_flu	string	Territory ID	NE Omaha, PA Pittsburgh

Acceptance Criteria

None

HTTP Request & Responses

When a lead is submitted, LeadConduit provides real-time feedback in the HTTP response body. The outcome is derived from a series of actions and rule evaluations that take place when the lead is processed through the Flow. One of three possible outcomes will be returned: Success, Failure, or Error.

Response outcomes are based on Fluent Solar LLC's configuration in their LeadConduit account. Contact Fluent Solar LLC for clarification about failures. Success and failure responses always contains the 24 character LeadConduit lead identifier. We recommend that you capture this value in your system as it can be used to track down discrepancies or help troubleshoot problems.

This source supports receiving leads using POST or GET. We strongly recommend using POST. To see example requests and responses, select your method and header parameters from the dropdown below.

Method

POST POST as x-www-form-urlencoded request, respond with JSON

Request

The HTTP request to the submission URL listed above.

POST https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit HTTP/1.1

Accept: application/json
Content-Type: application/x-www-form-urlencoded
Content-Length: 512

first_name=Mike&last_name=Jones&phone_1=5127891111&email=mikejones32%40gmail.com&address_1=123%20Main%20Street&address_2=Unit%20C&city=Austin&state=TX&postal_code=78751&trustedform_cert_url=https%3A%2F%2Fcert.trustedform.com%2Fa1028cbb41b876744fa752eec276bec0e4c48b33&utility_company_flu=any%20text&utility_bill_flu=any%20text&credit_rating=excellent&tracking_id_flu=any%20text&phone_2=5127891111&phone_3=5127891111&universal_leadid=063A3537-2A60-890C-5F89-D2435448FD1D&lead_price_flu=%2410&office_flu=NE%20Omaha

Response - Success

The lead was accepted.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "success",
  "lead": {
    "id": "5e256787fa37—c91d526odfe"
  },
  "price": 2.43
}

Response - Failure

The lead was rejected. The reason field explains why.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "failure",
  "reason": "lead.city must not be equal to austin",
  "lead": {
    "id": "5e25cbe0bb6c0070ca4797fe"
  },
  "price": 0
}

Response - Error

An unexpected problem occurred and lead handling was unable to proceed normally. The lead was not accepted. The reason field provides more detail.

HTTP/1.1 422 Unprocessable entity
Content—Type: application/json

{
  "message": "Invalid source ID"
}

GET GET request, respond with JSON

Request

The HTTP request to the submission URL listed above.

GET https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit?first_name=Mike&last_name=Jones&phone_1=5127891111&email=mikejones32%40gmail.com&address_1=123%20Main%20Street&address_2=Unit%20C&city=Austin&state=TX&postal_code=78751&trustedform_cert_url=https%3A%2F%2Fcert.trustedform.com%2Fa1028cbb41b876744fa752eec276bec0e4c48b33&utility_company_flu=any%20text&utility_bill_flu=any%20text&credit_rating=excellent&tracking_id_flu=any%20text&phone_2=5127891111&phone_3=5127891111&universal_leadid=063A3537-2A60-890C-5F89-D2435448FD1D&lead_price_flu=%2410&office_flu=NE%20Omaha HTTP/1.1

Accept: application/json

Response - Success

The lead was accepted.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "success",
  "lead": {
    "id": "5e256787fa37—c91d526odfe"
  },
  "price": 2.43
}

Response - Failure

The lead was rejected. The reason field explains why.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "failure",
  "reason": "lead.city must not be equal to austin",
  "lead": {
    "id": "5e25cbe0bb6c0070ca4797fe"
  },
  "price": 0
}

Response - Error

An unexpected problem occurred and lead handling was unable to proceed normally. The lead was not accepted. The reason field provides more detail.

HTTP/1.1 422 Unprocessable entity
Content—Type: application/json

{
  "message": "Invalid source ID"
}

POST POST as JSON request, respond with JSON

Request

The HTTP request to the submission URL listed above.

POST https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit HTTP/1.1

Accept: application/json
Content-Type: application/json
Content-Length: 641

{
  "first_name": "Mike",
  "last_name": "Jones",
  "phone_1": "5127891111",
  "email": "[email protected]",
  "address_1": "123 Main Street",
  "address_2": "Unit C",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78751",
  "trustedform_cert_url": "https://cert.trustedform.com/a1028cbb41b876744fa752eec276bec0e4c48b33",
  "utility_company_flu": "any text",
  "utility_bill_flu": "any text",
  "credit_rating": "excellent",
  "tracking_id_flu": "any text",
  "phone_2": "5127891111",
  "phone_3": "5127891111",
  "universal_leadid": "063A3537-2A60-890C-5F89-D2435448FD1D",
  "lead_price_flu": "$10",
  "office_flu": "NE Omaha"
}

Response - Success

The lead was accepted.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "success",
  "lead": {
    "id": "5e256787fa37—c91d526odfe"
  },
  "price": 2.43
}

Response - Failure

The lead was rejected. The reason field explains why.

HTTP/1.1 201 Created
Content—Type: application/json

{
  "outcome": "failure",
  "reason": "lead.city must not be equal to austin",
  "lead": {
    "id": "5e25cbe0bb6c0070ca4797fe"
  },
  "price": 0
}

Response - Error

An unexpected problem occurred and lead handling was unable to proceed normally. The lead was not accepted. The reason field provides more detail.

HTTP/1.1 422 Unprocessable entity
Content—Type: application/json

{
  "message": "Invalid source ID"
}

POST POST as XML request, respond with XML

Request

The HTTP request to the submission URL listed above.

POST https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit HTTP/1.1

Accept: text/xml
Content-Type: text/xml
Content-Length: 843

<?xml version="1.0"?>
<lead>
  <first_name>Mike</first_name>
  <last_name>Jones</last_name>
  <phone_1>5127891111</phone_1>
  <email>[email protected]</email>
  <address_1>123 Main Street</address_1>
  <address_2>Unit C</address_2>
  <city>Austin</city>
  <state>TX</state>
  <postal_code>78751</postal_code>
  <trustedform_cert_url>https://cert.trustedform.com/a1028cbb41b876744fa752eec276bec0e4c48b33</trustedform_cert_url>
  <utility_company_flu>any text</utility_company_flu>
  <utility_bill_flu>any text</utility_bill_flu>
  <credit_rating>excellent</credit_rating>
  <tracking_id_flu>any text</tracking_id_flu>
  <phone_2>5127891111</phone_2>
  <phone_3>5127891111</phone_3>
  <universal_leadid>063A3537-2A60-890C-5F89-D2435448FD1D</universal_leadid>
  <lead_price_flu>$10</lead_price_flu>
  <office_flu>NE Omaha</office_flu>
</lead>

Response - Success

The lead was accepted.

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <outcome>success</outcome>
  <lead>
    <id>5e256787fa37—c91d526odfe</id>
  </lead>
  <price>2.43</price>
</result>

Response - Failure

The lead was rejected. The reason field explains why.

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <outcome>failure</outcome>
  <reason>lead.city must not be equal to austin</reason>
  <lead>
    <id>5e256787fa37—c91d526odfe<iid>
  </lead>
  <price>0</price>
</result>

Response - Error

An unexpected problem occurred and lead handling was unable to proceed normally. The lead was not accepted. The reason field provides more detail.

HTTP/1.1 422 Unprocessable entity
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <message>invalid source id</message>
</result>

POST POST as x-www-form-urlencoded request, respond with XML

Request

The HTTP request to the submission URL listed above.

POST https://example.leadprosper.tech/leadconduit/flows/6359956c475d02348d8418d1/sources/63ef2aba71b7bd03d6901451/submit HTTP/1.1

Accept: text/xml
Content-Type: application/x-www-form-urlencoded
Content-Length: 512

first_name=Mike&last_name=Jones&phone_1=5127891111&email=mikejones32%40gmail.com&address_1=123%20Main%20Street&address_2=Unit%20C&city=Austin&state=TX&postal_code=78751&trustedform_cert_url=https%3A%2F%2Fcert.trustedform.com%2Fa1028cbb41b876744fa752eec276bec0e4c48b33&utility_company_flu=any%20text&utility_bill_flu=any%20text&credit_rating=excellent&tracking_id_flu=any%20text&phone_2=5127891111&phone_3=5127891111&universal_leadid=063A3537-2A60-890C-5F89-D2435448FD1D&lead_price_flu=%2410&office_flu=NE%20Omaha

Response - Success

The lead was accepted.

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <outcome>success</outcome>
  <lead>
    <id>5e256787fa37—c91d526odfe</id>
  </lead>
  <price>2.43</price>
</result>

Response - Failure

The lead was rejected. The reason field explains why.

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <outcome>failure</outcome>
  <reason>lead.city must not be equal to austin</reason>
  <lead>
    <id>5e256787fa37—c91d526odfe<iid>
  </lead>
  <price>0</price>
</result>

Response - Error

An unexpected problem occurred and lead handling was unable to proceed normally. The lead was not accepted. The reason field provides more detail.

HTTP/1.1 422 Unprocessable entity
Content-Type: text/xml

<?xml version="1.0"?>
<result>
  <message>invalid source id</message>
</result>