API Referenceprospects

Create Prospect Portal Invitation

<Badge>Available by Request</Badge> Get the resident portal link for a prospect, so you can send them an invitation to register and apply. If the prospect has no portal account yet, one is created and its claim link is returned. Repeat calls return the same link, and no email or SMS is sent — delivering the link is up to you. Once the prospect has claimed their account, the property's portal login link is returned instead, with `isClaimed: true`. The same link is also exposed as `portalInviteUrl` on `GET /prospects` and `GET /prospects/{prospectId}`. Returns `400` when the resident portal is not active for the prospect's property, or when the prospect's email address already belongs to another portal account. <Warning> The claim link lets whoever holds it set the prospect's portal password. Send it only to the prospect. </Warning> <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

prospectIdstringRequiredformat: "uuid"
The id of the prospect

Response

The prospect's portal link
prospectIdstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
portalUserIdstringOptionalformat: "uuid"
The id of the prospect's portal account.
isClaimedbooleanOptional

Whether the prospect has already claimed their portal account. When true, portalInviteUrl is the portal login link rather than a claim link.

portalInviteUrlstringOptionalformat: "uri"

The link to send the prospect: the claim link, which opens the portal’s account setup prefilled with their name and email, or the login link once claimed.