POST api/Augmentation

Allows an update of the lead's current status.

Request Information

URI Parameters

None.

Body Parameters

AugmentationHeader
NameDescriptionTypeAdditional information
UserName

string

None.

Password

string

None.

DateSent

date

None.

AugmentationData

AugmentationData

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "DateSent": "2021-10-28T14:04:00.8968655+02:00",
  "AugmentationData": {
    "LeadId": 1,
    "TargetCampaignCode": "sample string 2",
    "LeadStatus": 0,
    "StatusReason": "sample string 3",
    "CampaignRuleId": "d325c4ad-0f61-4da9-bc56-bee32d104cc1",
    "LeadParameters": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<AugmentationHeader xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
  <DateSent>2021-10-28T14:04:00.8968655+02:00</DateSent>
  <AugmentationData>
    <LeadId>1</LeadId>
    <TargetCampaignCode>sample string 2</TargetCampaignCode>
    <LeadStatus>NewlyReceived</LeadStatus>
    <StatusReason>sample string 3</StatusReason>
    <CampaignRuleId>d325c4ad-0f61-4da9-bc56-bee32d104cc1</CampaignRuleId>
    <LeadParameters>
      <LeadRequestParameter>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </LeadRequestParameter>
      <LeadRequestParameter>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </LeadRequestParameter>
    </LeadParameters>
  </AugmentationData>
</AugmentationHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

DateStamp

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "DateStamp": "2021-10-28T14:04:00.9124885+02:00"
}

application/xml, text/xml

Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Message>sample string 2</Message>
  <DateStamp>2021-10-28T14:04:00.9124885+02:00</DateStamp>
</Response>