POST leads/create

Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadSource	string	None.
Status	integer	None.
Classification	integer	None.
ExternalLeadSourceID	string	None.
ExternalLeadSource	string	None.
OwnerID	integer	None.
Groups	Collection of string	None.
Tags	Collection of string	None.
Note	string	None.
PrimaryApplicant	PrimaryApplicantModel	None.
CoApplicants	Collection of CoApplicantModel	None.
MortgageInquiry	MortgageInquiryModel	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadSource": "sample string 1",
  "Status": 1,
  "Classification": 1,
  "ExternalLeadSourceID": "sample string 2",
  "ExternalLeadSource": "sample string 3",
  "OwnerID": 4,
  "Groups": [
    "sample string 1",
    "sample string 2"
  ],
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "Note": "sample string 5",
  "PrimaryApplicant": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "MobileNumber": "sample string 4",
    "OtherGivenName": "sample string 5",
    "DateOfBirth": "sample string 6",
    "SIN": "sample string 7",
    "MartialStatus": 1,
    "PreferredLanguage": 1,
    "ResidentialStatus": 1,
    "SelfEmployed": true,
    "WorkPhone": "sample string 8",
    "CreditRating": 1,
    "IncomeRange": 1,
    "Citizenship": 1,
    "MailingAddress": {
      "AddressId": 1,
      "Unit": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetType": "sample string 5",
      "StreetDirection": "sample string 6",
      "City": "sample string 7",
      "Province": "sample string 8",
      "PostalCode": "sample string 9",
      "Country": "sample string 10"
    },
    "CustomFields": [
      {
        "FieldName": "sample string 1",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "FieldName": "sample string 1",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  "CoApplicants": [
    {
      "RelationShipToPrimaryApplicant": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3",
      "MobileNumber": "sample string 4",
      "OtherGivenName": "sample string 5",
      "DateOfBirth": "sample string 6",
      "SIN": "sample string 7",
      "MartialStatus": 1,
      "PreferredLanguage": 1,
      "ResidentialStatus": 1,
      "SelfEmployed": true,
      "WorkPhone": "sample string 8",
      "CreditRating": 1,
      "IncomeRange": 1,
      "Citizenship": 1,
      "MailingAddress": {
        "AddressId": 1,
        "Unit": "sample string 2",
        "StreetNumber": "sample string 3",
        "StreetName": "sample string 4",
        "StreetType": "sample string 5",
        "StreetDirection": "sample string 6",
        "City": "sample string 7",
        "Province": "sample string 8",
        "PostalCode": "sample string 9",
        "Country": "sample string 10"
      },
      "CustomFields": [
        {
          "FieldName": "sample string 1",
          "FieldValues": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "FieldName": "sample string 1",
          "FieldValues": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "RelationShipToPrimaryApplicant": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3",
      "MobileNumber": "sample string 4",
      "OtherGivenName": "sample string 5",
      "DateOfBirth": "sample string 6",
      "SIN": "sample string 7",
      "MartialStatus": 1,
      "PreferredLanguage": 1,
      "ResidentialStatus": 1,
      "SelfEmployed": true,
      "WorkPhone": "sample string 8",
      "CreditRating": 1,
      "IncomeRange": 1,
      "Citizenship": 1,
      "MailingAddress": {
        "AddressId": 1,
        "Unit": "sample string 2",
        "StreetNumber": "sample string 3",
        "StreetName": "sample string 4",
        "StreetType": "sample string 5",
        "StreetDirection": "sample string 6",
        "City": "sample string 7",
        "Province": "sample string 8",
        "PostalCode": "sample string 9",
        "Country": "sample string 10"
      },
      "CustomFields": [
        {
          "FieldName": "sample string 1",
          "FieldValues": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "FieldName": "sample string 1",
          "FieldValues": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "MortgageInquiry": {
    "SearchStatus": 1,
    "PropertyUsage": 1,
    "LoanPurpose": 1,
    "LoanType": 1,
    "Timing": 1,
    "RenewalDate": "sample string 1",
    "PropertyType": 1,
    "PurchasePrice": 1.0,
    "PropertyValue": 1.0,
    "DownPayment": 1.0,
    "AdditionalCash": 1.0,
    "LoanAmount": 2.0,
    "PropertyAddress": {
      "Unit": "sample string 1",
      "StreetNumber": "sample string 2",
      "StreetName": "sample string 3",
      "StreetType": "sample string 4",
      "StreetDirection": "sample string 5",
      "City": "sample string 6",
      "Province": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9"
    },
    "CustomFields": [
      {
        "FieldName": "sample string 1",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "FieldName": "sample string 1",
        "FieldValues": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<CreateLeadApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <Classification>1</Classification>
  <CoApplicants>
    <CoApplicantModel>
      <Citizenship>1</Citizenship>
      <CreditRating>1</CreditRating>
      <CustomFields>
        <APICustomFieldModel>
          <FieldName>sample string 1</FieldName>
          <FieldValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </FieldValues>
        </APICustomFieldModel>
        <APICustomFieldModel>
          <FieldName>sample string 1</FieldName>
          <FieldValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </FieldValues>
        </APICustomFieldModel>
      </CustomFields>
      <DateOfBirth>sample string 6</DateOfBirth>
      <Email>sample string 3</Email>
      <FirstName>sample string 1</FirstName>
      <IncomeRange>1</IncomeRange>
      <LastName>sample string 2</LastName>
      <MailingAddress>
        <City>sample string 7</City>
        <Country>sample string 10</Country>
        <PostalCode>sample string 9</PostalCode>
        <Province>sample string 8</Province>
        <StreetDirection>sample string 6</StreetDirection>
        <StreetName>sample string 4</StreetName>
        <StreetNumber>sample string 3</StreetNumber>
        <StreetType>sample string 5</StreetType>
        <Unit>sample string 2</Unit>
        <AddressId>1</AddressId>
      </MailingAddress>
      <MartialStatus>1</MartialStatus>
      <MobileNumber>sample string 4</MobileNumber>
      <OtherGivenName>sample string 5</OtherGivenName>
      <PreferredLanguage>1</PreferredLanguage>
      <ResidentialStatus>1</ResidentialStatus>
      <SIN>sample string 7</SIN>
      <SelfEmployed>true</SelfEmployed>
      <WorkPhone>sample string 8</WorkPhone>
      <RelationShipToPrimaryApplicant>1</RelationShipToPrimaryApplicant>
    </CoApplicantModel>
    <CoApplicantModel>
      <Citizenship>1</Citizenship>
      <CreditRating>1</CreditRating>
      <CustomFields>
        <APICustomFieldModel>
          <FieldName>sample string 1</FieldName>
          <FieldValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </FieldValues>
        </APICustomFieldModel>
        <APICustomFieldModel>
          <FieldName>sample string 1</FieldName>
          <FieldValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </FieldValues>
        </APICustomFieldModel>
      </CustomFields>
      <DateOfBirth>sample string 6</DateOfBirth>
      <Email>sample string 3</Email>
      <FirstName>sample string 1</FirstName>
      <IncomeRange>1</IncomeRange>
      <LastName>sample string 2</LastName>
      <MailingAddress>
        <City>sample string 7</City>
        <Country>sample string 10</Country>
        <PostalCode>sample string 9</PostalCode>
        <Province>sample string 8</Province>
        <StreetDirection>sample string 6</StreetDirection>
        <StreetName>sample string 4</StreetName>
        <StreetNumber>sample string 3</StreetNumber>
        <StreetType>sample string 5</StreetType>
        <Unit>sample string 2</Unit>
        <AddressId>1</AddressId>
      </MailingAddress>
      <MartialStatus>1</MartialStatus>
      <MobileNumber>sample string 4</MobileNumber>
      <OtherGivenName>sample string 5</OtherGivenName>
      <PreferredLanguage>1</PreferredLanguage>
      <ResidentialStatus>1</ResidentialStatus>
      <SIN>sample string 7</SIN>
      <SelfEmployed>true</SelfEmployed>
      <WorkPhone>sample string 8</WorkPhone>
      <RelationShipToPrimaryApplicant>1</RelationShipToPrimaryApplicant>
    </CoApplicantModel>
  </CoApplicants>
  <ExternalLeadSource>sample string 3</ExternalLeadSource>
  <ExternalLeadSourceID>sample string 2</ExternalLeadSourceID>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Groups>
  <LeadSource>sample string 1</LeadSource>
  <MortgageInquiry>
    <AdditionalCash>1</AdditionalCash>
    <CustomFields>
      <APICustomFieldModel>
        <FieldName>sample string 1</FieldName>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
      </APICustomFieldModel>
      <APICustomFieldModel>
        <FieldName>sample string 1</FieldName>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
      </APICustomFieldModel>
    </CustomFields>
    <DownPayment>1</DownPayment>
    <LoanAmount>2</LoanAmount>
    <LoanPurpose>1</LoanPurpose>
    <LoanType>1</LoanType>
    <PropertyAddress>
      <City>sample string 6</City>
      <Country>sample string 9</Country>
      <PostalCode>sample string 8</PostalCode>
      <Province>sample string 7</Province>
      <StreetDirection>sample string 5</StreetDirection>
      <StreetName>sample string 3</StreetName>
      <StreetNumber>sample string 2</StreetNumber>
      <StreetType>sample string 4</StreetType>
      <Unit>sample string 1</Unit>
    </PropertyAddress>
    <PropertyType>1</PropertyType>
    <PropertyUsage>1</PropertyUsage>
    <PropertyValue>1</PropertyValue>
    <PurchasePrice>1</PurchasePrice>
    <RenewalDate>sample string 1</RenewalDate>
    <SearchStatus>1</SearchStatus>
    <Timing>1</Timing>
  </MortgageInquiry>
  <Note>sample string 5</Note>
  <OwnerID>4</OwnerID>
  <PrimaryApplicant>
    <Citizenship>1</Citizenship>
    <CreditRating>1</CreditRating>
    <CustomFields>
      <APICustomFieldModel>
        <FieldName>sample string 1</FieldName>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
      </APICustomFieldModel>
      <APICustomFieldModel>
        <FieldName>sample string 1</FieldName>
        <FieldValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </FieldValues>
      </APICustomFieldModel>
    </CustomFields>
    <DateOfBirth>sample string 6</DateOfBirth>
    <Email>sample string 3</Email>
    <FirstName>sample string 1</FirstName>
    <IncomeRange>1</IncomeRange>
    <LastName>sample string 2</LastName>
    <MailingAddress>
      <City>sample string 7</City>
      <Country>sample string 10</Country>
      <PostalCode>sample string 9</PostalCode>
      <Province>sample string 8</Province>
      <StreetDirection>sample string 6</StreetDirection>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetType>sample string 5</StreetType>
      <Unit>sample string 2</Unit>
      <AddressId>1</AddressId>
    </MailingAddress>
    <MartialStatus>1</MartialStatus>
    <MobileNumber>sample string 4</MobileNumber>
    <OtherGivenName>sample string 5</OtherGivenName>
    <PreferredLanguage>1</PreferredLanguage>
    <ResidentialStatus>1</ResidentialStatus>
    <SIN>sample string 7</SIN>
    <SelfEmployed>true</SelfEmployed>
    <WorkPhone>sample string 8</WorkPhone>
  </PrimaryApplicant>
  <Status>1</Status>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
</CreateLeadApiModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateLeadApiModel'.

Response Information

Resource Description

CreateLeadOutput

Name	Description	Type	Additional information
LeadId		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<CreateLeadOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <LeadId>1</LeadId>
</CreateLeadOutput>