Create Applicant: Entrata
https://api.propexo.com/v1/applicants/entrata/| Method |
|---|
| applications/sendApplication |
| leads/updateLeads |
Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.
Authentication
- AuthorizationBearerBearer authentication of the form
Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
- Array [
- ]
- Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
The Propexo unique identifier for the integration
The Propexo unique identifier for the property
The Propexo unique identifier for the lease period
The Propexo unique identifier for the lead source
The Propexo unique identifier for the unit
The first address line associated with the applicant
The status associated with the application
Show 2 enum values
COMPLETEDAPPROVEDThe city associated with the applicant
The first name associated with the applicant
The last name associated with the applicant
The state associated with the applicant
The zip code associated with the applicant
The second address line associated with the applicant
attachments object[]
Files to upload for the applicant
The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB.
Possible values: <= 69730304 characters
The name of the file including the extension. Ex: "image.jpg"
The mime type of the file. Ex: "image/jpeg"
Deprecated: Use the file_type_id field instead. The PMS specific lease file type of the document
The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type.
If the file should be marked as private. If true the file will not be shown in the resident portal.
The date of birth associated with the applicant
The primary email address associated with the applicant
events object[]deprecated
DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant
The Propexo unique identifier for the unit
The PMS id for the event type.
The PMS id for the leasing agent.
The PMS id for the event sub type.
The PMS id for the event result.
The date and time that the event occured.
The date and time that the appointment will occur. Required if using appointment type.
General notes about the event.
Title for the event.
The reason the event occurred.
The move-in date associated with the applicant
Primary phone number associated with the applicant
pets object[]
Pets of the applicant
The Propexo unique identifier for the pet type
The age in years of the applicant pet
Possible values: >= 0
The name associated with the applicant pet
The breed of the applicant pet
The gender of the applicant pet
The color of the applicant pet
The weight in pounds of the applicant pet
Possible values: >= 0
Description of the applicant pet
The city where the applicant pet license was issued
The license number of the applicant pet
Whether the applicant pet is a service animal
Whether the applicant pet is fixed
The date when the applicant pet was spayed or neutered
Show 2 variants
Whether the applicant pet is house broken
Special provisions or requirements for the applicant pet
vehicles object[]
Vehicles of the applicant
The type associated with the applicant vehicle
Show 3 enum values
PRIMARYSECONDARYOTHERThe make of the applicant vehicle
The Propexo data model (e.g. units, residents, applicants, etc.) associated with the applicant vehicle
The year of the applicant vehicle
The color of the applicant vehicle
The license plate number of the applicant vehicle
The state associated with the applicant vehicle
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTThe country associated with the applicant vehicle
The permit number of the applicant vehicle
Notes associated with the applicant vehicle
employment_history object[]
Employment history of the applicant
The name associated with the income type
Show 3 enum values
CURRENT_EMPLOYERPREVIOUS_EMPLOYEROTHER_INCOMEThe frequency of the applicant employer
Show 3 enum values
WEEKLYMONTHLYYEARLYThe position of the employee
The name associated with the applicant employer
Primary phone number associated with the applicant employer
The first address line associated with the applicant employer
The second address line associated with the applicant employer
The third address line associated with the applicant employer
The city associated with the applicant employer
The state associated with the applicant employer
The province associated with the applicant employer
The zip code associated with the applicant employer
The country associated with the applicant employer
The total income of the employee, in cents
Possible values: >= 0
The name associated with the employee
The name associated with the employee
Primary phone number associated with the employee
The primary email address associated with the employee
The effective date of the income of the employee
Show 2 variants
The start date associated with the employee
Show 2 variants
The end date associated with the employee
Show 2 variants
add_ons object[]
Add-ons of the applicant
The Propexo unique identifier for the rentable item
The Propexo unique identifier for the employee
The start date associated with the employee
Show 2 variants
The end date associated with the employee
Show 2 variants
Response
Successful response
- Array [
- ]
- Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
- Array [
- string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - string<date-time>
- stringPattern:
^\d{4}-\d{2}-\d{2}$ - ]
meta objectrequired
result objectrequired
The Propexo unique identifier for the integration
The Propexo unique identifier for the property
The Propexo unique identifier for the lease period
The Propexo unique identifier for the lead source
The first address line associated with the applicant
The status associated with the application
Show 2 enum values
COMPLETEDAPPROVEDThe city associated with the applicant
The first name associated with the applicant
The last name associated with the applicant
The state associated with the applicant
The zip code associated with the applicant
attachments object[]required
The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB.
Possible values: <= 69730304 characters
The name of the file including the extension. Ex: "image.jpg"
The mime type of the file. Ex: "image/jpeg"
events object[]required
The PMS id for the event type.
pets object[]required
The Propexo unique identifier for the pet type
Possible values: >= 0
Possible values: >= 0
Show 2 variants
vehicles object[]required
The type associated with the applicant vehicle
Show 3 enum values
PRIMARYSECONDARYOTHERShow 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYTemployment_history object[]required
The name associated with the income type
Show 3 enum values
CURRENT_EMPLOYERPREVIOUS_EMPLOYEROTHER_INCOMEThe frequency of the applicant employer
Show 3 enum values
WEEKLYMONTHLYYEARLYPossible values: >= 0
Show 2 variants
Show 2 variants
Show 2 variants
add_ons object[]required
The Propexo unique identifier for the rentable item
The Propexo unique identifier for the employee
Show 2 variants
Show 2 variants
Errors
400Bad Request
error objectrequired
codestringrequiredExample:invalid_requestmessagestringrequiredExample:invalid requestdetails object
property name*anyExample:{"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
curl -X POST https://api.propexo.com/v1/applicants/entrata/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_id": "string",
"property_id": "string",
"lease_period_id": "string",
"lead_source_id": "string",
"address_1": "string",
"application_status": "COMPLETED",
"city": "string",
"first_name": "string",
"last_name": "string",
"state": "string",
"zip": "string"
}'
{
"meta": {
"job_id": "string"
},
"result": {
"integration_id": "string",
"property_id": "string",
"lease_period_id": "string",
"lead_source_id": "string",
"unit_id": "string",
"address_1": "string",
"application_status": "COMPLETED",
"city": "string",
"first_name": "string",
"last_name": "string",
"state": "string",
"zip": "string",
"address_2": "string",
"attachments": "Unknown Type: array,null",
"date_of_birth": "2024-07-29T15:51:28.071Z",
"events": "Unknown Type: array,null",
"move_in_date": "2024-07-29T15:51:28.071Z",
"phone_1": "string",
"pets": "Unknown Type: array,null",
"vehicles": "Unknown Type: array,null",
"employment_history": "Unknown Type: array,null",
"add_ons": "Unknown Type: array,null"
}
}