For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all applications
        • GETGet an application by ID
        • POSTCreate Application: ResMan
        • PUTUpdate Application: ResMan
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
ResManApplications

Create Application: ResMan

POST
/v1/applications/resman/
POST
/v1/applications/resman/
$curl -X POST https://api.propexo.com/v1/applications/resman/ \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "integration_id": "intg-987654321",
>  "property_id": "prop-123456789",
>  "unit_id": "unit-101",
>  "lead_source_id": "leadsrc-55555",
>  "employee_id": "emp-2023",
>  "application_date": "2024-04-10T14:00:00Z",
>  "start_date": "2024-05-01",
>  "end_date": "2025-04-30",
>  "status": "PENDING",
>  "first_name": "Emily",
>  "last_name": "Johnson"
>}'
1{
2  "meta": {
3    "job_id": "job-abc123xyz"
4  },
5  "result": {
6    "integration_id": "intg-987654321",
7    "property_id": "prop-123456789",
8    "unit_id": "unit-101",
9    "lead_source_id": "leadsrc-55555",
10    "employee_id": "emp-2023",
11    "application_date": "2024-04-10T14:00:00Z",
12    "start_date": "2024-05-01",
13    "end_date": "2025-04-30",
14    "status": "PENDING",
15    "first_name": "Emily",
16    "last_name": "Johnson",
17    "email_1": "emily.johnson@example.com",
18    "phone_1": "+1-555-123-4567",
19    "phone_1_type": "MOBILE",
20    "phone_2": "+1-555-765-4321",
21    "phone_2_type": "WORK",
22    "date_of_birth": "1990-07-15",
23    "address_1": "123 Maple Street",
24    "address_2": "Apt 4B",
25    "city": "Springfield",
26    "state": "IL",
27    "zip": "62704",
28    "notes": "Applicant prefers a unit with a balcony.",
29    "move_in_date": "2024-05-01",
30    "rent_amount_in_cents": 120000,
31    "desired_lease_term_in_months": 12,
32    "floor_plan_id": "fp-2024-01",
33    "other_occupants": [
34      {
35        "first_name": "Michael",
36        "last_name": "Johnson",
37        "email_1": "michael.johnson@example.com",
38        "phone_1": "+1-555-234-5678",
39        "phone_1_type": "MOBILE",
40        "phone_2": "+1-555-876-5432",
41        "phone_2_type": "HOME",
42        "address_1": "123 Maple Street",
43        "address_2": "Apt 4B",
44        "city": "Springfield",
45        "state": "IL",
46        "zip": "62704",
47        "date_of_birth": "1988-03-22",
48        "move_in_date": "2024-05-01",
49        "rent_amount_in_cents": 0
50      }
51    ],
52    "emergency_contacts": [
53      {
54        "first_name": "Sarah",
55        "last_name": "Williams",
56        "relationship": "Sister",
57        "address_1": "456 Oak Avenue",
58        "city": "Springfield",
59        "state": "IL",
60        "zip": "62705",
61        "country": "USA",
62        "phone_1": "+1-555-345-6789"
63      }
64    ],
65    "employment_history": [
66      {
67        "name": "Tech Solutions Inc.",
68        "income_in_cents": 8500000,
69        "frequency": "MONTHLY",
70        "start_date": "2018-06-01",
71        "end_date": "2024-03-31",
72        "position": "Software Engineer",
73        "address_1": "789 Innovation Drive",
74        "city": "Springfield",
75        "state": "IL",
76        "zip": "62706",
77        "country": "USA",
78        "supervisor_first_name": "John",
79        "supervisor_last_name": "Doe",
80        "supervisor_phone": "+1-555-456-7890"
81      }
82    ],
83    "vehicles": [
84      {
85        "make": "Toyota",
86        "model": "Camry",
87        "color": "Blue",
88        "license_plate_number": "ABC1234",
89        "license_plate_state": "IL",
90        "permit_number": "P-789456"
91      }
92    ],
93    "pets": [
94      {
95        "type": "Dog",
96        "name": "Buddy",
97        "weight_in_pounds": 45
98      }
99    ]
100  }
101}
Create Application: ResMan. Note: When reading in the newly created application we cannot filter by the application_id, so we must pull in all residents and applicants to save the newly created application.This may result in an increase in the total number of records processed | Interface | Method | |---|---| | Lead Management | /MITS/PostLeadManagement4_0 | | Lease Application | /MITS/PostLeaseApplication3_0 | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>
Was this page helpful?
Previous

Update Application: ResMan

Next
Built with

Create Application: ResMan. Note: When reading in the newly created application we cannot filter by the application_id, so we must pull in all residents and applicants to save the newly created application.This may result in an increase in the total number of records processed

InterfaceMethod
Lead Management/MITS/PostLeadManagement4_0
Lease Application/MITS/PostLeaseApplication3_0
Notice
This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
The Propexo unique identifier for the integration
property_idstringRequired
The Propexo unique identifier for the property
unit_idstringRequired
The Propexo unique identifier for the unit
lead_source_idstringRequired
The Propexo unique identifier for the lead source
employee_idstringRequired
The Propexo unique identifier for the employee
application_datestringRequired
The application date associated with the applicant
start_datestringRequired
The start date associated with the lease
end_datestringRequired
The end date associated with the lease
statusenumRequired
The status associated with the application
Allowed values:
first_namestringRequired
The first name associated with the applicant
last_namestringRequired
The last name associated with the applicant
email_1stringOptional
The primary email address associated with the applicant
phone_1stringOptional
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptional
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
date_of_birthstringOptional
The date of birth associated with the applicant
address_1stringOptional
The first address line associated with the applicant
address_2stringOptional
The second address line associated with the applicant
citystringOptional
The city associated with the applicant
statestringOptional
The state associated with the applicant
zipstringOptional
The zip code associated with the applicant
notesstringOptional
Notes associated with the applicant
move_in_datestringOptional

The move-in date associated with the applicant

rent_amount_in_centsintegerOptional>=0
The rent amount in cents for the applicant
desired_lease_term_in_monthsdoubleOptional>=0
The amount of months for the lease term
floor_plan_idstringOptional
The Propexo unique identifier for the floor plan
other_occupantslist of objectsOptional
A list of other occupants for the application
emergency_contactslist of objectsOptional

A list of emergency contacts for the applicant. Note: This will only be added to the primary applicant on the application.

employment_historylist of objectsOptional

The employment history of the applicant. Note: This will only be added to the primary applicant on the application. Only entries with both income_in_cents and frequency will be included.

vehicleslist of objectsOptional
A list of vehicles for the application
petslist of objectsOptional
A list of applicant pets

Response

Successful response
metaobject
resultobject

Errors

400
Bad Request Error