Skip to main content
POST
/
firms
/
{id}
/
leads
Create Lead for Firm
curl --request POST \
  --url https://api.realtor.dit.myperch.io/v1/firms/{id}/leads \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "firstName": "Natasha",
  "lastName": "Blick",
  "phone": {
    "number": "2534062008",
    "extension": "841"
  },
  "clientData": {
    "sin": "970886723",
    "prefix": "Mr.",
    "citizenship": "Canadian Citizen",
    "dateOfBirth": "1958-05-03",
    "maritalStatus": "Single",
    "creditScoreEstimation": "789"
  },
  "resourceType": "Firm",
  "resourceId": "j86ZGq9d",
  "referredByReferralCodeId": null
}
'
{
  "data": {
    "id": "g4XWxPqY",
    "createdAt": "2025-07-22T21:17:14.867Z",
    "updatedAt": "2025-07-22T21:17:14.867Z",
    "email": "[email protected]",
    "firstName": "Natasha",
    "lastName": "Blick",
    "resourceType": "Firm",
    "resourceId": "j86ZGq9d",
    "deletedAt": "2023-11-07T05:31:56Z",
    "phone": {
      "number": "<string>",
      "extension": "<string>"
    },
    "clientData": {
      "advisorProfileId": "<string>",
      "citizenship": "Canadian Citizen",
      "creditScoreEstimation": "700",
      "dateOfBirth": "1980-01-01",
      "isFirstTimeHomeBuyer": true,
      "maritalStatus": "Married",
      "prefix": "Mrs.",
      "sin": "123456789",
      "Assets": [
        {
          "type": "Savings",
          "description": "Savings account at RBC",
          "value": 10000
        }
      ],
      "Incomes": [
        {
          "type": "Employment",
          "startedOn": "2018-01-01",
          "endedOn": "2022-12-31",
          "description": "Cyberdyne Systems",
          "streams": {},
          "employmentDetails": {
            "type": "Salaried",
            "jobTitle": "Accountant",
            "phone": "{\"number\":\"6471234567\",\"extension\":\"123\"}",
            "sector": "Financial Services",
            "businessName": "Acme Inc.",
            "address": {
              "unitNumber": "<string>",
              "streetNumber": "<string>",
              "streetName": "<string>",
              "locality": "<string>",
              "administrativeArea": "<string>",
              "postalCode": "<string>",
              "country": "<string>",
              "premise": "<string>",
              "googlePlaceId": "<string>",
              "locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
            },
            "businessType": "Sole Proprietorship",
            "businessEstablishedOn": "2019-01-01",
            "businessAnnualGrossRevenue": "10000",
            "probationEndsOn": "2022-01-01"
          }
        }
      ],
      "ClientResidencies": [
        {
          "occupancyType": "Resider",
          "startsOn": "2018-01-01",
          "locality": "<string>",
          "administrativeArea": "<string>",
          "postalCode": "<string>",
          "country": "<string>",
          "endsOn": "2022-12-31",
          "monthlyRent": 2000,
          "unitNumber": "<string>",
          "streetNumber": "<string>",
          "streetName": "<string>",
          "premise": "<string>",
          "googlePlaceId": "<string>",
          "locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}"
        }
      ],
      "Plans": [
        {
          "type": "Buying",
          "id": "<string>",
          "leadId": "<string>",
          "referralCodeId": "<string>",
          "realtorProfileId": "<string>"
        }
      ],
      "Properties": [
        {
          "type": "Detached",
          "status": "Owned",
          "occupancyType": "Owner Occupied",
          "purchasePrice": 500000,
          "purchasedOn": "2018-01-01",
          "monthlyTotalRent": 2000,
          "costs": {
            "annualPropertyTaxes": 123,
            "monthlyMaintenanceFee": 123
          },
          "unitNumber": "<string>",
          "streetNumber": "<string>",
          "streetName": "<string>",
          "locality": "<string>",
          "administrativeArea": "<string>",
          "postalCode": "<string>",
          "country": "<string>",
          "premise": "<string>",
          "googlePlaceId": "<string>",
          "locationGeometry": "{\"type\":\"Point\",\"coordinates\":[-79.3832,43.6532]}",
          "Liabilities": [
            {
              "type": "Alimony",
              "balance": "<string>",
              "creditLimit": "<string>",
              "lenderName": "<string>",
              "maturesOn": "2023-12-25",
              "paymentAmount": "<string>",
              "paymentDetails": {
                "isInterestOnly": true,
                "isPropertyTaxIncluded": true
              },
              "paymentFrequency": "Weekly",
              "rate": 123,
              "rateType": "Fixed",
              "description": "<string>",
              "termMonths": 123,
              "position": 123,
              "ChildLiabilities": [
                {
                  "type": "HELOC",
                  "balance": "<string>",
                  "creditLimit": "<string>",
                  "lenderName": "<string>",
                  "maturesOn": "2023-12-25",
                  "paymentAmount": "<string>",
                  "paymentDetails": {
                    "isInterestOnly": true,
                    "isPropertyTaxIncluded": true
                  },
                  "paymentFrequency": "Weekly",
                  "rate": 123,
                  "rateType": "Fixed",
                  "description": "<string>",
                  "termMonths": 123
                }
              ]
            }
          ]
        }
      ],
      "notes": "<string>"
    },
    "referredByReferralCodeId": "<string>",
    "convertedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The id of the record to retrieve.

Example:

"abc123"

Body

application/json

The data to create the record with.

​
email
string<email>
required

The client's email address

Example:

"[email protected]"

​
firstName
string
required

The client's first name

Example:

"Natasha"

​
lastName
string
required

The client's last name

Example:

"Blick"

​
resourceType
enum<string>
required

The resource type of the lead owner

Available options:
ClientProfile,
Firm,
FirmMember
Example:

"Firm"

​
resourceId
string
required

The resource ID of the lead owner

Example:

"j86ZGq9d"

​
phone
object

The client's phone number

​
clientData
object

The user data for the lead

​
referredByReferralCodeId
string | null

Support only: The referral source of the lead. This referral source takes priority over the lead owner during lead conversion.

Response

201 - application/json

Successful response

​
data
object