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: Yardi
        • PUTUpdate Application: Yardi
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Yardi (Legacy)Applications

Update Application: Yardi

PUT
/v1/applications/yardi/:application_id
PUT
/v1/applications/yardi/:application_id
$curl -X PUT https://api.propexo.com/v1/applications/yardi/application_id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "applicant_id": "applicant-12345"
>}'
1{
2 "meta": {
3 "job_id": "job-67890"
4 },
5 "result": {
6 "application_id": "application-54321",
7 "applicant_id": "applicant-12345",
8 "first_name": "Emily",
9 "last_name": "Johnson",
10 "middle_name": "Grace",
11 "maiden_name": "Smith",
12 "email_1": "emily.johnson@example.com",
13 "phone_1": "4155551234",
14 "phone_1_type": "MOBILE",
15 "phone_2": "4155555678",
16 "phone_2_type": "HOME",
17 "move_in_date": "2024-05-01T14:00:00Z",
18 "move_out_date": "2025-04-30T14:00:00Z",
19 "desired_lease_term_in_months": "12",
20 "date_of_birth": "1990-08-15",
21 "notes": "Applicant prefers a unit with a balcony.",
22 "is_evicted": false,
23 "is_felony": false,
24 "is_criminal_charge": false,
25 "eviction_description": "",
26 "felony_description": "",
27 "criminal_charge_description": "",
28 "marital_status": "SINGLE",
29 "identification_number": "123-45-6789",
30 "drivers_license_number": "D1234567",
31 "address_history": [
32 {
33 "address_1": "123 Maple Street",
34 "city": "San Francisco",
35 "state": "CA",
36 "zip": "94107",
37 "notice_provided": true,
38 "move_in_date": "2020-06-01",
39 "country": "United States",
40 "property_name": "Maple Apartments",
41 "reason_for_leaving": "Relocating for work",
42 "monthly_payment_in_cents": 250000,
43 "move_out_date": "2024-04-30",
44 "manager_phone": "4155557890",
45 "manager_email": "manager@mapleapts.com",
46 "management_company": "Maple Property Management"
47 }
48 ],
49 "emergency_contacts": [
50 {
51 "first_name": "Sarah",
52 "last_name": "Johnson",
53 "relationship": "SISTER",
54 "address_1": "456 Oak Avenue",
55 "city": "San Jose",
56 "state": "CA",
57 "zip": "95112",
58 "country": "United States",
59 "phone_1": "4085554321"
60 }
61 ],
62 "employment_history": [
63 {
64 "is_current_employer": true,
65 "name": "Tech Solutions Inc.",
66 "start_date": "2018-09-15",
67 "monthly_income_in_cents": 850000,
68 "end_date": "",
69 "address_1": "789 Innovation Drive",
70 "city": "San Francisco",
71 "state": "CA",
72 "zip": "94105",
73 "phone": "4155556789",
74 "supervisor_first_name": "Mark",
75 "supervisor_last_name": "Davis",
76 "position": "Software Engineer"
77 }
78 ],
79 "other_income": [
80 {
81 "source": "Freelance Consulting",
82 "monthly_income_in_cents": 150000
83 }
84 ],
85 "vehicles": [
86 {
87 "make": "Toyota",
88 "model": "Camry",
89 "year": 2018,
90 "color": "Blue",
91 "license_plate_number": "7ABC123",
92 "license_plate_state": "CA"
93 }
94 ],
95 "pets": [
96 {
97 "type": "Dog",
98 "name": "Buddy",
99 "age_in_years": 3,
100 "weight_in_pounds": 45,
101 "breed": "Golden Retriever",
102 "color": "Golden",
103 "gender": "Male",
104 "is_fixed": true,
105 "is_service_animal": false
106 }
107 ],
108 "concession_fees": [
109 {
110 "start_date": "2024-05-01",
111 "end_date": "2024-10-31",
112 "concession_id": "concession-001"
113 }
114 ],
115 "application_fees": [
116 {
117 "charge_code_id": "fee-123",
118 "amount_in_cents": 5000,
119 "description": "Application processing fee"
120 }
121 ],
122 "other_occupants": [
123 {
124 "relationship": "ROOMMATE",
125 "first_name": "Alex",
126 "last_name": "Martinez",
127 "third_party_id": "occupant-789",
128 "organization_name": "Propexo",
129 "email_1": "alex.martinez@example.com",
130 "phone_1": "4155559876",
131 "phone_1_type": "MOBILE",
132 "phone_2": "4155556543",
133 "phone_2_type": "WORK",
134 "address_1": "123 Maple Street",
135 "city": "San Francisco",
136 "state": "CA",
137 "zip": "94107"
138 }
139 ]
140 }
141}
Update Application: Yardi | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login | | ILS Guest Card | ImportApplication_Login |
Was this page helpful?
Previous

Get all appointments

Next
Built with

Update Application: Yardi

InterfaceMethod
ILS Guest CardImportYardiGuest_Login
ILS Guest CardImportApplication_Login

Authentication

AuthorizationBearer

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

Path parameters

application_idstringRequired
The Propexo unique identifier for the application

Request

This endpoint expects an object.
applicant_idstringRequired
The Propexo unique identifier for the applicant
first_namestringOptional
The first name associated with the applicant
last_namestringOptional
The last name associated with the applicant
middle_namestringOptional
The middle name associated with the applicant
maiden_namestringOptional
The maiden name associated with the applicant
email_1stringOptionalformat: "email"
The primary email address associated with the applicant
phone_1stringOptionalformat: "^\d{10}$"
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptionalformat: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
move_in_datestringOptional

The desired move-in date to the unit listed in the application

move_out_datestringOptional

The desired move-out date to the unit listed in the application

desired_lease_term_in_monthsstringOptional
The desired lease term in months of the applicant
date_of_birthstringOptional
The date of birth associated with the applicant
notesstringOptional
Notes associated with the applicant
is_evictedbooleanOptional
Whether the applicant has been evicted
is_felonybooleanOptional
Whether the applicant has a felony
is_criminal_chargebooleanOptional
Whether the applicant has a criminal charge
eviction_descriptionstringOptional
The description of the eviction
felony_descriptionstringOptional
The description of the felony
criminal_charge_descriptionstringOptional
The description of the criminal charge
marital_statusenumOptional
The marital status of the applicant
Allowed values:
identification_numberstringOptional
The social security number of the applicant
drivers_license_numberstringOptional
The driver's license number of the applicant
address_historylist of objectsOptional
The address history of the applicant
emergency_contactslist of objectsOptional
A list of emergency contacts for the applicant
employment_historylist of objectsOptional
The employment history of the applicant
other_incomelist of objectsOptional
A list of other income sources for the applicant
vehicleslist of objectsOptional
A list of vehicles for the application
petslist of objectsOptional
A list of applicant pets. If any pets are provided, this list will overwrite the existing list of pets
concession_feeslist of objectsOptional
A list of concession fees for the application
application_feeslist of objectsOptional
A list of application fees for the application. Only new application fees should be passed in, existing fees cannot be updated
other_occupantslist of objectsOptional
A list of other occupants for the application. Only new occupants should be passed in, existing occupants cannot be updated

Response

Successful response
metaobject
resultobject

Errors

400
Bad Request Error