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.

<Badge>Available by Request</Badge> Update an existing prospect's contact details, housing preferences, or referral source. Only the fields included in the request body are modified. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

prospectIdstringRequired

The id of the prospect

Request

This endpoint expects an object.

Response

The updated prospect

idstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

preferredNamestringOptional

emailstringOptional

phonestringOptional

referralSourcestringOptional

preferencesobjectOptional

idempotencyIdstringOptionalformat: "uuid"

readableIdstringOptional

createdAtdatetimeOptional

updatedAtdatetimeOptional

1	{
2	"id": "id",
3	"propertyId": "propertyId",
4	"organizationId": "organizationId",
5	"firstName": "firstName",
6	"middleName": "middleName",
7	"lastName": "lastName",
8	"preferredName": "preferredName",
9	"email": "email",
10	"phone": "phone",
11	"referralSource": "referralSource",
12	"preferences": {
13	"numBeds": 1,
14	"numBaths": 1,
15	"minPrice": 1,
16	"maxPrice": 1,
17	"moveInStart": "2024-01-15T09:30:00Z"
18	},
19	"idempotencyId": "idempotencyId",
20	"readableId": "readableId",
21	"createdAt": "2024-01-15T09:30:00Z",
22	"updatedAt": "2024-01-15T09:30:00Z"
23	}

$	curl -X PUT https://api.fortresstech.io/v1/prospects/prospectId \
>	-H "Content-Type: application/json" \
>	-d '{}'