Update Prospect Status

PUT

https://api.fortresstech.io/v1/prospects/:prospectId/status

Available by Request

Update the status of an existing prospect. Optionally attach a note describing the reason for the change, which is recorded on the prospect’s activity history. See GET /prospectStatuses for the full catalogue of valid status ids.

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 new status for the prospect

prospectStatusIdstringRequiredformat: "uuid"

The id of the prospect status to apply. See GET /prospectStatuses for valid values.

notesstring or nullOptional

An optional note describing the reason for the status change. Never required, even when the target status reports requiresNote: true — that flag reflects Fortress UI behavior only and is not enforced here.

Response

The updated prospect

idstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

prospectStatusIdstringOptionalformat: "uuid"

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

preferredNamestringOptional

emailstringOptional

phonestringOptional

idempotencyIdstring or nullOptionalformat: "uuid"

readableIdstring or nullOptional

createdAtdatetimeOptional

updatedAtdatetimeOptional