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": "client1+21135778@example.com",
"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",
"deletedAt": "2023-11-07T05:31:56Z",
"email": "client1+21135778@example.com",
"firstName": "Natasha",
"lastName": "Blick",
"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",
"businessType": "Sole Proprietorship",
"businessEstablishedOn": "2019-01-01",
"businessAnnualGrossRevenue": "10000",
"businessName": "Acme Inc.",
"probationEndsOn": "2022-01-01",
"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]}"
}
}
}
],
"ClientResidencies": [
{
"occupancyType": "Resider",
"startsOn": "2018-01-01",
"endsOn": "2022-12-31",
"monthlyRent": 2000,
"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]}"
}
],
"Plans": [
{
"id": "<string>",
"leadId": "<string>",
"referralCodeId": "<string>",
"type": "Buying",
"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>",
"description": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"termMonths": 123,
"position": 123,
"ChildLiabilities": [
{
"type": "HELOC",
"balance": "<string>",
"creditLimit": "<string>",
"description": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"termMonths": 123
}
]
}
]
}
],
"notes": "<string>"
},
"resourceType": "Firm",
"resourceId": "j86ZGq9d",
"referredByReferralCodeId": "<string>",
"convertedAt": "2023-11-07T05:31:56Z"
}
}
Creates a record in the Lead table based on passed parameters and implicit access controls.
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": "client1+21135778@example.com",
"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",
"deletedAt": "2023-11-07T05:31:56Z",
"email": "client1+21135778@example.com",
"firstName": "Natasha",
"lastName": "Blick",
"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",
"businessType": "Sole Proprietorship",
"businessEstablishedOn": "2019-01-01",
"businessAnnualGrossRevenue": "10000",
"businessName": "Acme Inc.",
"probationEndsOn": "2022-01-01",
"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]}"
}
}
}
],
"ClientResidencies": [
{
"occupancyType": "Resider",
"startsOn": "2018-01-01",
"endsOn": "2022-12-31",
"monthlyRent": 2000,
"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]}"
}
],
"Plans": [
{
"id": "<string>",
"leadId": "<string>",
"referralCodeId": "<string>",
"type": "Buying",
"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>",
"description": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"termMonths": 123,
"position": 123,
"ChildLiabilities": [
{
"type": "HELOC",
"balance": "<string>",
"creditLimit": "<string>",
"description": "<string>",
"lenderName": "<string>",
"maturesOn": "2023-12-25",
"paymentAmount": "<string>",
"paymentDetails": {
"isInterestOnly": true,
"isPropertyTaxIncluded": true
},
"paymentFrequency": "Weekly",
"rate": 123,
"rateType": "Fixed",
"termMonths": 123
}
]
}
]
}
],
"notes": "<string>"
},
"resourceType": "Firm",
"resourceId": "j86ZGq9d",
"referredByReferralCodeId": "<string>",
"convertedAt": "2023-11-07T05:31:56Z"
}
}
The id of the record to retrieve.
"abc123"
The data to create the record with.
The body is of type object
.
Successful response
The response is of type object
.