POST api/lead/leadV2

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Customer	CustomerDTO	None.
MortgageType	string	None.
LoanValue	integer	None.
Status	string	None.
LeadSource	string	None.
LeadStatus	string	None.
CreatedOn	date	None.
Mobile	string	None.
LeadSourceDetail	string	None.
OrganisationName	string	None.
Environment	string	None.
CreditLogicReturnStatus	string	None.
ToLetOut	string	None.
BuyerType	string	None.
MostImportant	string	None.
AdditionalInfo	string	None.
InvestmentProperty	string	None.
SelfBuild	string	None.
SelfBuild2	string	None.
BuyerStage	string	None.
BuyerStage2	string	None.
MortgageTypeDetail	string	None.
EmploymentType	string	None.
GrossVariableIncome	decimal number	None.
GrossBasicIncome	decimal number	None.
LeadAppointment	LeadAppointmentDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Customer": {
    "Id": 1,
    "Name": "sample string 2",
    "FirstName": "sample string 3",
    "Surname": "sample string 4",
    "Email": "sample string 5",
    "Mobile": "sample string 6",
    "Consent": 7,
    "EmailConsent": 8,
    "OnlineConsent": 9,
    "PhoneConsent": 10,
    "PostConsent": 11,
    "SmsConsent": 12,
    "ThirdPartyMarketingConsent": 13,
    "PreferredContactTime": "sample string 14",
    "FullName": "sample string 15"
  },
  "MortgageType": "sample string 2",
  "LoanValue": 1,
  "Status": "sample string 3",
  "LeadSource": "sample string 4",
  "LeadStatus": "sample string 5",
  "CreatedOn": "2025-12-11T22:06:04.9794544+00:00",
  "Mobile": "sample string 6",
  "LeadSourceDetail": "sample string 7",
  "OrganisationName": "sample string 8",
  "Environment": "sample string 9",
  "CreditLogicReturnStatus": "sample string 10",
  "ToLetOut": "sample string 11",
  "BuyerType": "sample string 12",
  "MostImportant": "sample string 13",
  "AdditionalInfo": "sample string 14",
  "InvestmentProperty": "sample string 15",
  "SelfBuild": "sample string 16",
  "SelfBuild2": "sample string 17",
  "BuyerStage": "sample string 18",
  "BuyerStage2": "sample string 19",
  "MortgageTypeDetail": "sample string 20",
  "EmploymentType": "sample string 21",
  "GrossVariableIncome": 1.1,
  "GrossBasicIncome": 1.1,
  "LeadAppointment": {
    "action": "sample string 1",
    "action_noun": "sample string 2",
    "action_verb": "sample string 3",
    "appointment": {
      "id": 1,
      "appointment_type_id": "sample string 2",
      "appointment_type_slug": "sample string 3",
      "customer_id": "sample string 4",
      "customer_information": {
        "name": 1,
        "email": "sample string 2"
      },
      "start_date": "sample string 5",
      "end_date": "sample string 6",
      "status": "sample string 7",
      "date_created": "sample string 8",
      "date_modified": "sample string 9",
      "public_edit_url": "sample string 10",
      "price_full": 11.1,
      "payment_method": "sample string 12",
      "web_meeting_url": "sample string 13",
      "web_meeting_password": "sample string 14",
      "appointment_type_title": "sample string 15"
    },
    "team_members": [
      {
        "id": 1,
        "wp_user_id": 2,
        "name": "sample string 3",
        "display_name": "sample string 4",
        "email": "sample string 5"
      },
      {
        "id": 1,
        "wp_user_id": 2,
        "name": "sample string 3",
        "display_name": "sample string 4",
        "email": "sample string 5"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<LeadDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MoneySherpaRepository.DataTransferObjects">
  <AdditionalInfo>sample string 14</AdditionalInfo>
  <BuyerStage>sample string 18</BuyerStage>
  <BuyerStage2>sample string 19</BuyerStage2>
  <BuyerType>sample string 12</BuyerType>
  <CreatedOn>2025-12-11T22:06:04.9794544+00:00</CreatedOn>
  <CreditLogicReturnStatus>sample string 10</CreditLogicReturnStatus>
  <Customer>
    <Consent>7</Consent>
    <Email>sample string 5</Email>
    <EmailConsent>8</EmailConsent>
    <FirstName>sample string 3</FirstName>
    <FullName>sample string 15</FullName>
    <Id>1</Id>
    <Mobile>sample string 6</Mobile>
    <Name>sample string 2</Name>
    <OnlineConsent>9</OnlineConsent>
    <PhoneConsent>10</PhoneConsent>
    <PostConsent>11</PostConsent>
    <PreferredContactTime>sample string 14</PreferredContactTime>
    <SmsConsent>12</SmsConsent>
    <Surname>sample string 4</Surname>
    <ThirdPartyMarketingConsent>13</ThirdPartyMarketingConsent>
  </Customer>
  <EmploymentType>sample string 21</EmploymentType>
  <Environment>sample string 9</Environment>
  <GrossBasicIncome>1.1</GrossBasicIncome>
  <GrossVariableIncome>1.1</GrossVariableIncome>
  <Id>1</Id>
  <InvestmentProperty>sample string 15</InvestmentProperty>
  <LeadAppointment>
    <action>sample string 1</action>
    <action_noun>sample string 2</action_noun>
    <action_verb>sample string 3</action_verb>
    <appointment>
      <appointment_type_id>sample string 2</appointment_type_id>
      <appointment_type_slug>sample string 3</appointment_type_slug>
      <appointment_type_title>sample string 15</appointment_type_title>
      <customer_id>sample string 4</customer_id>
      <customer_information>
        <email>sample string 2</email>
        <name>1</name>
      </customer_information>
      <date_created>sample string 8</date_created>
      <date_modified>sample string 9</date_modified>
      <end_date>sample string 6</end_date>
      <id>1</id>
      <payment_method>sample string 12</payment_method>
      <price_full>11.1</price_full>
      <public_edit_url>sample string 10</public_edit_url>
      <start_date>sample string 5</start_date>
      <status>sample string 7</status>
      <web_meeting_password>sample string 14</web_meeting_password>
      <web_meeting_url>sample string 13</web_meeting_url>
    </appointment>
    <team_members>
      <team_members>
        <display_name>sample string 4</display_name>
        <email>sample string 5</email>
        <id>1</id>
        <name>sample string 3</name>
        <wp_user_id>2</wp_user_id>
      </team_members>
      <team_members>
        <display_name>sample string 4</display_name>
        <email>sample string 5</email>
        <id>1</id>
        <name>sample string 3</name>
        <wp_user_id>2</wp_user_id>
      </team_members>
    </team_members>
  </LeadAppointment>
  <LeadSource>sample string 4</LeadSource>
  <LeadSourceDetail>sample string 7</LeadSourceDetail>
  <LeadStatus>sample string 5</LeadStatus>
  <LoanValue>1</LoanValue>
  <Mobile>sample string 6</Mobile>
  <MortgageType>sample string 2</MortgageType>
  <MortgageTypeDetail>sample string 20</MortgageTypeDetail>
  <MostImportant>sample string 13</MostImportant>
  <OrganisationName>sample string 8</OrganisationName>
  <SelfBuild>sample string 16</SelfBuild>
  <SelfBuild2>sample string 17</SelfBuild2>
  <Status>sample string 3</Status>
  <ToLetOut>sample string 11</ToLetOut>
</LeadDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.