Skip to navigation
API ReferenceProspects

Update Prospect

Available by Request

Update an existing prospect’s contact details, housing preferences, or referral source. Only the fields included in the request body are modified.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

prospectIdstringRequiredformat: "uuid"
The id of the prospect

Request

The prospect fields to update
firstNamestringOptional<=35 characters
middleNamestringOptional<=35 characters
lastNamestringOptional<=35 characters
preferredNamestringOptional<=35 characters
phonestringOptionalformat: "^\d{10}$"

The 10-digit primary phone number of the prospect.

emailstringOptionalformat: "email"
The primary email address of the prospect.
numBedsintegerOptional0-15
numBathsintegerOptional0-15
minPriceintegerOptional
maxPriceintegerOptional
moveInStartdatetimeOptional
introductoryNotestringOptional
referralTypeIdstringOptionalformat: "uuid"

Response

The updated prospect
idstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
firstNamestringOptional
middleNamestringOptional
lastNamestringOptional
preferredNamestringOptional
emailstringOptional
phonestringOptional
referralSourcestring or nullOptional
preferencesobject or nullOptional
idempotencyIdstring or nullOptionalformat: "uuid"
readableIdstring or nullOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional