Request Information

URI Parameters

None.

Body Parameters

The quick pre-qualification start email model.

QuickPreQualificationStartedEmailModel
NameDescriptionTypeAdditional information
borrower1Email

Gets or sets the borrower 1 email.

 string

None.
borrower1FirstName

Gets or sets the borrower 1 first name.

 string

None.
borrower1LastName

Gets or sets the borrower 1 last name.

 string

None.
borrower1MobileNumber

Gets or sets the borrower 1 mobile number.

 string

None.
borrower1UseIncome

Gets or sets a value indicating whether gets or sets the borrower 1 use income.

 boolean

None.
borrower2FirstName

Gets or sets the borrower 2 first name.

 string

None.
borrower2LastName

Gets or sets the borrower 2 last name.

 string

None.
borrower2UseIncome

Gets or sets a value indicating whether gets or sets the borrower 2 use income.

 boolean

None.
borrower3FirstName

Gets or sets the borrower 3 first name.

 string

None.
borrower3LastName

Gets or sets the borrower 3 last name.

 string

None.
borrower3UseIncome

Gets or sets a value indicating whether gets or sets the borrower 3 use income.

 boolean

None.
borrower4FirstName

Gets or sets the borrower 4 first name.

 string

None.
borrower4LastName

Gets or sets the borrower 4 last name.

 string

None.
borrower4UseIncome

Gets or sets a value indicating whether gets or sets the borrower 4 use income.

 boolean

None.
loanOfficerId

Gets or sets a value indicating the loan officer identifier.

 integer

None.
organization

Gets or sets the organization.

 string

None.
referralSourceType

Gets or sets the referral source type.

 string

None.
referralSource

Gets or sets the referral source.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "borrower1Email": "sample String 1",
  "borrower1FirstName": "sample String 2",
  "borrower1LastName": "sample String 3",
  "borrower1MobileNumber": "sample String 4",
  "borrower1UseIncome": true,
  "borrower2FirstName": "sample String 6",
  "borrower2LastName": "sample String 7",
  "borrower2UseIncome": true,
  "borrower3FirstName": "sample String 8",
  "borrower3LastName": "sample String 9",
  "borrower3UseIncome": true,
  "borrower4FirstName": "sample String 10",
  "borrower4LastName": "sample String 11",
  "borrower4UseIncome": true,
  "loanOfficerId": 1,
  "organization": "sample String 12",
  "referralSourceType": "sample String 13",
  "referralSource": "sample String 14"
}

text/html

Sample: 
{"borrower1Email":"sample String 1","borrower1FirstName":"sample String 2","borrower1LastName":"sample String 3","borrower1MobileNumber":"sample String 4","borrower1UseIncome":true,"borrower2FirstName":"sample String 6","borrower2LastName":"sample String 7","borrower2UseIncome":true,"borrower3FirstName":"sample String 8","borrower3LastName":"sample String 9","borrower3UseIncome":true,"borrower4FirstName":"sample String 10","borrower4LastName":"sample String 11","borrower4UseIncome":true,"loanOfficerId":1,"organization":"sample String 12","referralSourceType":"sample String 13","referralSource":"sample String 14"}

application/xml, text/xml

Sample: 
<QuickPreQualificationStartedEmailModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Borrower1Email>sample String 1</Borrower1Email>
  <Borrower1FirstName>sample String 2</Borrower1FirstName>
  <Borrower1LastName>sample String 3</Borrower1LastName>
  <Borrower1MobileNumber>sample String 4</Borrower1MobileNumber>
  <Borrower1UseIncome>true</Borrower1UseIncome>
  <Borrower2FirstName>sample String 6</Borrower2FirstName>
  <Borrower2LastName>sample String 7</Borrower2LastName>
  <Borrower2UseIncome>true</Borrower2UseIncome>
  <Borrower3FirstName>sample String 8</Borrower3FirstName>
  <Borrower3LastName>sample String 9</Borrower3LastName>
  <Borrower3UseIncome>true</Borrower3UseIncome>
  <Borrower4FirstName>sample String 10</Borrower4FirstName>
  <Borrower4LastName>sample String 11</Borrower4LastName>
  <Borrower4UseIncome>true</Borrower4UseIncome>
  <LoanOfficerId>1</LoanOfficerId>
  <Organization>sample String 12</Organization>
  <ReferralSourceType>sample String 13</ReferralSourceType>
  <ReferralSource>sample String 14</ReferralSource>
  <ToEmailAddressFound>true</ToEmailAddressFound>
</QuickPreQualificationStartedEmailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the action.

RPCResponse
NameDescriptionTypeAdditional information
data

Gets or sets the data.

 Object

None.
errors

Gets or sets the errors.

 Collection of RPCError2

None.
included

Gets or sets the included.

 Collection of Object

None.
messages

Gets or sets the errors.

 Collection of string

None.
modelId

Gets or sets the model identifier.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "data": {},
  "errors": [
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    },
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    }
  ],
  "included": [
    {},
    {}
  ],
  "messages": [
    "sample String 1",
    "sample String 2"
  ],
  "modelId": 1
}

text/html

Sample: 
{"data":{},"errors":[{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"},{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"}],"included":[{},{}],"messages":["sample String 1","sample String 2"],"modelId":1}