PX Open API Ping Post Leads

Ping Post – lead submit with Brand Consent results

Following Lead Ping Post integration type provides a possibility to submit Lead Pings with Brand Consent results.Leads with the brand included will be sold to a campaign from the scope of those that require brand consent and have a matching brand connected (either directly or through Parent-Alias & Alias-Parent-Alias relations)

Publisher setup

To get the list of potential brands for lead brand consent, we recommend to integrate MatchPing first.Publishers don’t require any special setup. Publisher types supported:

Ping Post

Lead Ping Example

The General Lead data structure is governed by vertical specs; Brand Consent section should be added on Ping after the VerifyAddress.

MatchPingID should match the one obtained during Match Ping from PX. Can be non-unique if Match Ping results are re-used or empty if Match Ping wasn’t called at all
Brand identifiers supported are Name, PxId, and Uid. Only one identifier should be submitted per brand
The brand section can also be omitted fully (in this case, lead still will be accepted and sold to campaigns that do not require brand consent)
Lead Post does not require and changes



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

<lead>

<ApiToken></ApiToken>

<Vertical></Vertical>

<SubId></SubId>

<UserAgent></UserAgent>

<OriginalUrl></OriginalUrl>

<Source></Source>

<JornayaLeadId></JornayaLeadId>

<TrustedForm></TrustedForm>

<SessionLength>38</SessionLength>

<TcpaText></TcpaText>

<VerifyAddress>false</VerifyAddress>

<MatchPingId></MatchPingId>

<BrandConsent>

<Brand>

<Name>Some brand name</Name>

</Brand>

<Brand>

<Name>Some brand name2</Name>

</Brand>

<Brand>

<Name>Some brand name3</Name>

</Brand>

</BrandConsent>

<ContactData>

</ContactData>

</lead>


{ 
"ApiToken": "", 
"Vertical":"", 
"SubId":"",
"UserAgent":"", 
"OriginalUrl":"", 
"Source":"", 
"JornayaLeadId":"", 
"TrustedForm":"", 
"SessionLength":"", 
"TcpaText":"", 
"VerifyAddress":"", 
"MatchPingId":"", 
"BrandConsent": [ 
    { "Name": "Some brand name" }, 
    { "Name": "Some brand name2" }, 
    { "Name": "Some brand name3" } 
    ], 
"ContactData": 
{ }
}

Success Ping


{
"TransactionId": "D0447C7B-452B-4F2A-9D7B-F3F72848EEE9",
"Success": true,
"Payout": 8.5,
"Message": null,
"Errors": null,
"Sold": null,
"Environment": "Testing"
}


<?xml version="1.0" encoding="UTF-8"?>
<Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<TransactionId>ce34e151-6d00-488d-a465-3fa3cebe7ff9</TransactionId>
	<Success>true</Success>
	<Payout>8.50</Payout>
	<Sold xsi:nil="true" />
	<Environment>Testing</Environment>
</Result>

Failure Ping

Failure in case there was more than one brand identifier per brand:


<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Result Value="BaeNOK">
        <Error>
            <Reason>Ambiguous Brand identification.</Reason>
            <Param></Param>
            <ExtraInfo>Section=BrandConsent.Brand.</ExtraInfo>
        </Error>
    </Result>
</Response>


{ 
  "Result Value": "BaeNOK", 
  "Reason": "Ambiguous Brand identification.", 
  "ExtraInfo": "Section=BrandConsent.Brand.", 
}