Applicant
{
"job_id": "string",
"data": {}
}
Body
The Propify unique identifier for the property
The Propify unique identifier for the unit
The ID of the lead source. This maps to the originatingLeadSourceId property of the Application object.
The status of the applicant's application either COMPLETED or APPROVED
COMPLETED
, APPROVED
The last name associated with the applicant
The last name associated with the applicant
The amount of months for the lease term.
3
, 6
, 9
, 12
, 15
, 18
The ID of the Floorplan in the PMS
The move-in date associated with the applicant
The PMS ID of the leasing agent for this applicant
The primary email address associated with the applicant
The date of birth associated with the applicant
The first address line associated with the applicant
Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.
The city associated with the applicant
The state associated with the applicant
The zip code associated with the applicant
'Primary phone number associated with the applicant
Files to upload to the applicant.
Array of events associated with this applicant
Custom data
Whether to send the new applicant an email with a link to the online application form. Defaults to FALSE.
The unit ID to associate the applicant with
Type of the primary phone number
HOME
, MOBILE
, WORK
'Secondary phone number associated with the applicant
Type of the secondary phone number
HOME
, MOBILE
, WORK
The property ID with which to associate the resident. This is the ID of the object in the PMS. Note that it should be passed as a string and not an integer.
The middle name of the resident. This value maps to the PrimaryContact.MiddleName property of the Tenant object
The Propify unique identifier for the lead
The end date associated with the lease
The start date associated with the lease
The end date associated with the lease
The status associated with the lease
PENDING
, APPROVED
, CANCELED
, DENIED
, SIGNED
The market rent amount in cents for the applicant
Response
The ID of the job created to handle this operation
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.