Update Application: Entrata | Propexo

curl -X PUT https://api.propexo.com/v1/applications/entrata/application_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "applicant_id": "applicant-12345"
}'

{
  "meta": {
    "job_id": "job-67890"
  },
  "result": {
    "applicant_id": "applicant-12345",
    "application_id": "application-98765",
    "lease_period_id": "leaseperiod-54321",
    "unit_id": "unit-11223",
    "lead_source_id": "leadsource-33445",
    "address_1": "123 Maple Street",
    "address_2": "Apt 4B",
    "application_status": "COMPLETED",
    "attachments": [
      {
        "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudA==",
        "file_name": "lease_agreement.pdf",
        "mime_type": "application/pdf",
        "file_type_id": "filetype-001",
        "is_private": true,
        "lease_file_type": "Lease Agreement"
      }
    ],
    "city": "Springfield",
    "create_new_events_only": true,
    "date_of_birth": "1990-05-20T00:00:00Z",
    "email_1": "jane.doe@example.com",
    "events": [
      {
        "x_type_id": "eventtype-001",
        "unit_id": "unit-11223",
        "x_leasing_agent_id": "agent-7890",
        "x_sub_type_id": "subtype-002",
        "x_result_id": "result-003",
        "event_datetime": "2024-04-10T14:00:00Z",
        "appointment_datetime": "2024-04-15T10:00:00Z",
        "time_from": "10:00",
        "time_to": "11:00",
        "notes": "Initial application review meeting",
        "title": "Application Review",
        "reasons_for_event": "Applicant screening",
        "id": "event-45678"
      }
    ],
    "first_name": "Jane",
    "last_name": "Doe",
    "move_in_date": "2024-06-01T00:00:00Z",
    "phone_1_type": "HOME",
    "phone_1": "+1-555-123-4567",
    "state": "IL",
    "zip": "62704",
    "pets": [
      {
        "pet_type_id": "pettype-001",
        "age_in_years": 3,
        "name": "Buddy",
        "breed": "Golden Retriever",
        "gender": "Male",
        "color": "Golden",
        "weight_in_pounds": 65,
        "description": "Friendly and well-trained",
        "license_city": "Springfield",
        "license_number": "SP123456",
        "is_service_animal": false,
        "is_fixed": true,
        "pet_spayed_or_neutered_date": "2021-08-15",
        "is_house_broken": true,
        "special_provisions": "None"
      }
    ],
    "vehicles": [
      {
        "vehicle_type": "PRIMARY",
        "make": "Toyota",
        "model": "Camry",
        "year": 2018,
        "color": "Blue",
        "license_plate_number": "ABC1234",
        "license_plate_state": "IL",
        "country_code": "US",
        "permit_number": "P123456",
        "notes": "Resident parking permit"
      }
    ],
    "employment_history": [
      {
        "income_type": "CURRENT_EMPLOYER",
        "frequency": "MONTHLY",
        "position": "Software Engineer",
        "name": "Tech Solutions Inc.",
        "phone": "+1-555-987-6543",
        "address_1": "456 Technology Drive",
        "address_2": "Suite 100",
        "address_3": "",
        "city": "Springfield",
        "state": "IL",
        "province": "",
        "zip": "62703",
        "country": "USA",
        "income_in_cents": 8500000,
        "supervisor_first_name": "John",
        "supervisor_last_name": "Smith",
        "supervisor_phone": "+1-555-987-6544",
        "supervisor_email": "john.smith@techsolutions.com",
        "income_effective_date": "2023-01-01",
        "start_date": "2020-06-15",
        "end_date": ""
      }
    ],
    "add_ons": [
      {
        "rentable_item_id": "rentableitem-001",
        "employee_id": "employee-123",
        "start_date": "2024-06-01",
        "end_date": "2025-06-01"
      }
    ]
  }
}

Update Application: Entrata

Method
applications/updateApplication
leases/sendLeaseDocuments
leads/updateLeads

Update Application: Entrata | Method | |---| | applications/updateApplication | | leases/sendLeaseDocuments | | leads/updateLeads |

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

lease_period_idstringOptional

The Propexo unique identifier for the lease period

unit_idstringOptional

The Propexo unique identifier for the unit

lead_source_idstringOptional

The Propexo unique identifier for the lead source

address_1stringOptional

The first address line associated with the applicant

address_2stringOptional

The second address line associated with the applicant

application_statusenumOptional

The status associated with the application

Allowed values:

attachmentslist of objectsOptional

Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB

citystringOptional

The city associated with the applicant

create_new_events_onlyboolean or stringOptional

Whether or not new events should be created on the applicant

date_of_birthstringOptionalformat: "date-time"

The date of birth associated with the applicant

email_1stringOptionalformat: "email"

The primary email address associated with the applicant

first_namestringOptional

The first name associated with the applicant

last_namestringOptional

The last name associated with the applicant

move_in_datestringOptionalformat: "date-time"

The move-in date associated with the applicant

phone_1_typeenumOptional

Type of the primary phone number

Allowed values:

phone_1stringOptional

Primary phone number associated with the applicant

statestringOptional

The state associated with the applicant

zipstringOptional

The zip code associated with the applicant

petslist of objectsOptional

Pets of the applicant

vehicleslist of objectsOptional

Vehicles of the applicant

employment_historylist of objectsOptional

Employment history of the applicant

add_onslist of objectsOptional

Add-ons of the applicant

eventslist of objectsOptionalDeprecated

DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error