Generate an applicant a link to the document upload portal

post

https://enterprise-api.demo.snappt.com/properties/{propertyId}/generate-applicant-link

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

propertyId

string

required

Body Params

firstName

string

Optional, first name of applicant

lastName

string

Optional, last name of applicant

middleInitial

string

Optional, middle initial of applicant (single uppercase letter)

applicantIdentifier

uuid

The applicant identifier that links this application to a previous application if it exists.

string

required

The applicant's email address.

phoneNumber

string

Optional phone number for the applicant. Must be 10-15 digits.

callbackUrl

uri

The URL to redirect the user to after they complete the document upload. If not provided, defaults to the Snappt application page.

externalId

string

Optional external identifier from your system (e.g., PMS/CRM prospect ID).

externalMetadata

object

Optional arbitrary metadata from your external system. Keys/values are stored but not interpreted by Snappt. Maximum size: 10KB.

linkOptions

object

Optional overrides for link expiration behavior.

Responses

200200