POST api/Lead

POST a new lead to the service

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ClientIpAddress	string	None.
ReferrerUrl	string	None.
UserAgent	string	None.
Product	string	None.
AffiliateShortCode	string	None.
LeadSource	string	None.
Channel	string	None.
LeadRequestParameters	Collection of LeadRequestParameter	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientIpAddress": "sample string 1",
  "ReferrerUrl": "sample string 2",
  "UserAgent": "sample string 3",
  "Product": "sample string 4",
  "AffiliateShortCode": "sample string 5",
  "LeadSource": "sample string 6",
  "Channel": "sample string 7",
  "LeadRequestParameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<LeadRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientIpAddress>sample string 1</ClientIpAddress>
  <ReferrerUrl>sample string 2</ReferrerUrl>
  <UserAgent>sample string 3</UserAgent>
  <Product>sample string 4</Product>
  <AffiliateShortCode>sample string 5</AffiliateShortCode>
  <LeadSource>sample string 6</LeadSource>
  <LeadChannel>sample string 7</LeadChannel>
  <LeadRequestParameters>
    <LeadRequestParameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </LeadRequestParameter>
    <LeadRequestParameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </LeadRequestParameter>
  </LeadRequestParameters>
  <AsyncLeadId>8</AsyncLeadId>
</LeadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadResponse

Name	Type	Additional information
LeadId	integer	None.
Successful	boolean	None.
IsDuplicate	boolean	None.
IsCapped	boolean	None.
Capped	boolean	None.
HttpStatusCode	HttpStatusCode	None.
Messages	Collection of LeadResponseMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "Successful": true,
  "IsDuplicate": true,
  "IsCapped": true,
  "Capped": true,
  "HttpStatusCode": 100,
  "Messages": [
    {
      "MessageType": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "MessageType": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<LeadResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LeadId>1</LeadId>
  <Successful>true</Successful>
  <IsDuplicate>true</IsDuplicate>
  <IsCapped>true</IsCapped>
  <HttpStatusCode>Continue</HttpStatusCode>
  <Messages>
    <LeadResponseMessage>
      <MessageType>sample string 1</MessageType>
      <Message>sample string 2</Message>
    </LeadResponseMessage>
    <LeadResponseMessage>
      <MessageType>sample string 1</MessageType>
      <Message>sample string 2</Message>
    </LeadResponseMessage>
  </Messages>
</LeadResponse>