PX Open API Direct Post Leads

Direct Post – lead submit with Brand Consent results

Following Lead Ping Post integration type provides a possibility to submit Lead Pings with Brand Consent results.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:

Direct Post
Branded
Common

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)
The General Lead data structure is governed by vertical specs; Brand Consent section should be added after the Transaction ID.

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 Example


{ 
  "ApiToken": "{{pub_exclusive}}", 
  "Vertical": "{{vertical}}", 
  "SubId": "test_lead", 
  "OriginalUrl": "https://google.com", 
  "Source": "test", 
  "JornayaLeadId": "0", 
  "SessionLength": "38", 
  "TcpaText": "I concent", 
  "VerifyAddress": "false", 
  "TransactionId": "", 
  "MatchPingId": "{{matchPingId}}", 
  "BrandConsent": [ 
    { 
      "Name": "Some brand name"
    }, 
    { 
      "Name": "Some brand name2"
    }, 
    { 
      "Name": "Some brand name3" 
    } 
    ], 
  "ContactData": { }
}


<?xml version="1.0" encoding="UTF-8"?>
<Lead>
  <ApiToken>{{pub_exclusive}}</ApiToken>
  <Vertical>{{vertical}}</Vertical>
  <SubId>test_lead</SubId>
  <OriginalUrl>https://google.com</OriginalUrl>
  <Source>test</Source>
  <JornayaLeadId>0</JornayaLeadId>
  <SessionLength>38</SessionLength>
  <TcpaText>I concent</TcpaText>
  <VerifyAddress>false</VerifyAddress>
  <TransactionId></TransactionId>
  <MatchPingId>{{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>

Direct Post – Lead submit with Brand Consent Response

Success

Our API does not provide info about the lead being sold or not with Direct Post.

Failure

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.", 
}