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: Entrata
        • PUTUpdate Application: Entrata
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
EntrataApplications

Create Application: Entrata

POST
/v1/applications/entrata/
POST
/v1/applications/entrata/
$curl -X POST https://api.propexo.com/v1/applications/entrata/ \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "integration_id": "intg-987654321",
>  "property_id": "prop-123456789",
>  "lease_period_id": "lease-2024Q2",
>  "lead_source_id": "leadsrc-456789123",
>  "application_status": "COMPLETED",
>  "first_name": "Emily",
>  "last_name": "Johnson"
>}'
1{
2  "meta": {
3    "job_id": "job-20240615-001"
4  },
5  "result": {
6    "integration_id": "intg-987654321",
7    "property_id": "prop-123456789",
8    "lease_period_id": "lease-2024Q2",
9    "lead_source_id": "leadsrc-456789123",
10    "unit_id": "unit-101A",
11    "application_status": "COMPLETED",
12    "first_name": "Emily",
13    "last_name": "Johnson",
14    "address_1": "123 Maple Street",
15    "address_2": "Apt 4B",
16    "city": "Springfield",
17    "state": "IL",
18    "zip": "62704",
19    "attachments": [
20      {
21        "file_name": "lease_agreement.pdf",
22        "mime_type": "application/pdf",
23        "file_data": "SGVsbG8gV29ybGQ=",
24        "lease_file_type": "Lease Agreement",
25        "file_type_id": "filetype-lease-agreement",
26        "is_private": true
27      }
28    ],
29    "date_of_birth": "1990-05-20",
30    "email_1": "emily.johnson@example.com",
31    "move_in_date": "2024-07-01",
32    "phone_1": "+1-217-555-1234",
33    "pets": [
34      {
35        "pet_type_id": "pettype-dog",
36        "age_in_years": 3,
37        "name": "Buddy",
38        "breed": "Golden Retriever",
39        "gender": "Male",
40        "color": "Golden",
41        "weight_in_pounds": 65,
42        "description": "Friendly and energetic",
43        "license_city": "Springfield",
44        "license_number": "SP123456",
45        "is_service_animal": false,
46        "is_fixed": true,
47        "pet_spayed_or_neutered_date": "2021-06-15",
48        "is_house_broken": true,
49        "special_provisions": "Requires daily walks"
50      }
51    ],
52    "vehicles": [
53      {
54        "vehicle_type": "PRIMARY",
55        "make": "Toyota",
56        "model": "Camry",
57        "year": 2018,
58        "color": "Blue",
59        "license_plate_number": "ABC1234",
60        "license_plate_state": "IL",
61        "country_code": "US",
62        "permit_number": "PRMT-5678",
63        "notes": "Parked in assigned spot 12"
64      }
65    ],
66    "employment_history": [
67      {
68        "income_type": "CURRENT_EMPLOYER",
69        "frequency": "MONTHLY",
70        "position": "Software Engineer",
71        "name": "Tech Solutions Inc.",
72        "phone": "+1-217-555-6789",
73        "address_1": "456 Technology Drive",
74        "address_2": "Suite 200",
75        "address_3": "",
76        "city": "Springfield",
77        "state": "IL",
78        "province": "",
79        "zip": "62703",
80        "country": "USA",
81        "income_in_cents": 8500000,
82        "supervisor_first_name": "Mark",
83        "supervisor_last_name": "Smith",
84        "supervisor_phone": "+1-217-555-9876",
85        "supervisor_email": "mark.smith@techsolutions.com",
86        "income_effective_date": "2023-01-01",
87        "start_date": "2020-06-15",
88        "end_date": "2024-06-30"
89      }
90    ],
91    "add_ons": [
92      {
93        "rentable_item_id": "rentable-parking-spot-12",
94        "employee_id": "emp-789456123",
95        "start_date": "2024-07-01",
96        "end_date": "2025-06-30"
97      }
98    ],
99    "other_occupants": [
100      {
101        "first_name": "Michael",
102        "last_name": "Johnson",
103        "relationship": "SPOUSE",
104        "email_1": "michael.johnson@example.com",
105        "phone_1": "+1-217-555-4321",
106        "date_of_birth": "1988-11-10",
107        "address_1": "123 Maple Street",
108        "address_2": "Apt 4B",
109        "city": "Springfield",
110        "state": "IL",
111        "zip": "62704"
112      }
113    ]
114  }
115}
Create Application: Entrata | Method | |---| | applications/sendApplication | | leads/updateLeads | <Note title="Notice">Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.</Note>
Was this page helpful?
Previous

Update Application: Entrata

Next
Built with

Create Application: Entrata

Method
applications/sendApplication
leads/updateLeads
Notice
Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

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
lease_period_idstringRequired
The Propexo unique identifier for the lease period
lead_source_idstringRequired
The Propexo unique identifier for the lead source
application_statusenumRequired
The status associated with the application
Allowed values:
first_namestringRequired
The first name associated with the application
last_namestringRequired
The last name associated with the application
unit_idstringOptional
The Propexo unique identifier for the unit
address_1stringOptional
The first address line associated with the application
address_2stringOptional
The second address line associated with the application
citystringOptional
The city associated with the application
statestringOptional
The state associated with the application
zipstringOptional
The zip code associated with the application
attachmentslist of objectsOptional
Files to upload for the application
date_of_birthstringOptional
The date of birth associated with the application
email_1stringOptionalformat: "email"
The primary email address associated with the application
move_in_datestringOptional

The move-in date associated with the application

phone_1stringOptional
Primary phone number associated with the application
petslist of objectsOptional

Pets of the application. Note: This will only be added to the primary applicant on the application.

vehicleslist of objectsOptional

Vehicles of the application. Note: This will only be added to the primary applicant on the application.

employment_historylist of objectsOptional

Employment history of the application. Note: This will only be added to the primary applicant on the application.

add_onslist of objectsOptional

Add-ons of the application

other_occupantslist of objectsOptional
Other occupants of the application

Response

Successful response
metaobject
resultobject

Errors

400
Bad Request Error