Skip to main content
PATCH
/
leads
/
{id}
Update Lead
curl --request PATCH \
  --url https://api.realtor.dit.myperch.io/v1/leads/{id} \
  --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"
  }
}
'
{
  "data": {
    "id": "g4XWxPqY",
    "createdAt": "2025-07-22T21:17:14.867Z",
    "updatedAt": "2025-07-22T21:17:14.867Z",
    "deletedAt": null,
    "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,
    "convertedAt": null
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The id of the record to update.

Body

application/json

The data to update 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

Successful response

​
data
object