Skip to navigation
API ReferenceProspects

Create Prospect

Create a new prospect record to track potential residents interested in your properties. Prospects can include contact information, property preferences (bedrooms, bathrooms, price range), move-in timeline, and referral source. At least one contact method (phone or email) is required to create a prospect.

Authentication

x-api-keystring
API Key authentication via header

Request

The prospect to create
propertyIdstringRequiredformat: "uuid"
firstNamestringOptional
lastNamestringOptional
phonestringOptionalformat: "^\d{10}$"

The 10-digit phone number of the prospect. At least one of phone or email is required.

emailstringOptionalformat: "email"
The email of the prospect. At least one of phone or email is required.
numBedsintegerOptional<=15
numBathsintegerOptional<=15
minPriceintegerOptional
maxPriceintegerOptional
moveInStartdatetimeOptional
introductoryNotestringOptional
referralTypeIdstringOptionalformat: "uuid"
isCorporationbooleanOptional

Response

The created prospect
idstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
firstNamestringOptional
lastNamestringOptional
emailstringOptional
phonestringOptional
referralSourcestringOptional
idempotencyIdstring or nullOptional
readableIdstring or nullOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetime or nullOptional