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": "client1+74049788@example.com",
  "firstName": "Amya",
  "lastName": "Williamson",
  "phone": {
    "number": "2925655632",
    "extension": "562"
  },
  "clientData": {
    "sin": "004877852",
    "prefix": "Ms.",
    "citizenship": "Permanent Legal Resident (PR)",
    "dateOfBirth": "1987-07-13",
    "maritalStatus": "Married",
    "creditScoreEstimation": "142"
  }
}
'
{
  "data": {
    "id": "38owigkM",
    "createdAt": "2026-03-05T19:39:18.389Z",
    "updatedAt": "2026-03-05T19:39:18.389Z",
    "deletedAt": null,
    "email": "client1+74049788@example.com",
    "firstName": "Amya",
    "lastName": "Williamson",
    "phone": {
      "number": "2925655632",
      "extension": "562"
    },
    "clientData": {
      "sin": "004877852",
      "prefix": "Ms.",
      "citizenship": "Permanent Legal Resident (PR)",
      "dateOfBirth": "1987-07-13",
      "maritalStatus": "Married",
      "creditScoreEstimation": "142"
    },
    "resourceType": "Firm",
    "resourceId": "qSBKZzUi",
    "referredByReferralCodeId": null,
    "convertedAt": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.myperch.io/llms.txt

Use this file to discover all available pages before exploring further.

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:

"client1+74049788@example.com"

​
firstName
string
required

The client's first name

Example:

"Amya"

​
lastName
string
required

The client's last name

Example:

"Williamson"

​
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:

"qSBKZzUi"

​
phone
object

The client's phone number

​
clientData
object

The user data for the lead

Response

Successful response

​
data
object