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.

Request

This endpoint expects an object.

propertyIdstringRequiredformat: "uuid"

emailstringOptionalformat: "email"

The email of the prospect. At least one of phone or email is required.

firstNamestringOptional

introductoryNotestringOptional

isCorporationbooleanOptional

lastNamestringOptional

maxPriceintegerOptional

minPriceintegerOptional

moveInStartdatetimeOptional

numBathsintegerOptional<=15

numBedsintegerOptional<=15

phonestringOptionalformat: "^\d{10}$"

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

referralTypeIdstringOptionalformat: "uuid"

Response

The created prospect

idstring or nullformat: "uuid"

propertyIdstring or nullformat: "uuid"

organizationIdstring or nullformat: "uuid"

firstNamestring or null

lastNamestring or null

emailstring or null

phonestring or null

referralSourcestring or null

idempotencyIdstring or null

readableIdstring or null

createdAtdatetime or null

updatedAtdatetime or null

deletedAtdatetime or null

1	import requests
2
3	url = "https://api.fortresstech.io/v1/prospects"
4
5	payload = { "propertyId": "propertyId" }
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.post(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"id": "id",
3	"propertyId": "propertyId",
4	"organizationId": "organizationId",
5	"firstName": "firstName",
6	"lastName": "lastName",
7	"email": "email",
8	"phone": "phone",
9	"referralSource": "referralSource",
10	"idempotencyId": "idempotencyId",
11	"readableId": "readableId",
12	"createdAt": "2024-01-15T09:30:00Z",
13	"updatedAt": "2024-01-15T09:30:00Z",
14	"deletedAt": "2024-01-15T09:30:00Z"
15	}