Create Applicant: Entrata

POST

/v1/applicants/entrata/

POST

/v1/applicants/entrata/

curl -X POST https://api.propexo.com/v1/applicants/entrata/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-987654321",
  "property_id": "prop-123456789",
  "lease_period_id": "lease-2024Q3",
  "lead_source_id": "leadsrc-456789123",
  "address_1": "123 Maple Street",
  "application_status": "COMPLETED",
  "city": "Springfield",
  "first_name": "Emily",
  "last_name": "Johnson",
  "state": "IL",
  "zip": "62704"
}'

{
  "meta": {
    "job_id": "job-20240615-001"
  },
  "result": {
    "integration_id": "intg-987654321",
    "property_id": "prop-123456789",
    "lease_period_id": "lease-2024Q3",
    "lead_source_id": "leadsrc-456789123",
    "unit_id": "unit-101",
    "address_1": "123 Maple Street",
    "application_status": "COMPLETED",
    "city": "Springfield",
    "first_name": "Emily",
    "last_name": "Johnson",
    "state": "IL",
    "zip": "62704",
    "address_2": "Apt 4B",
    "attachments": [
      {
        "file_name": "lease_agreement.pdf",
        "mime_type": "application/pdf",
        "file_data": "SGVsbG8gV29ybGQ=",
        "lease_file_type": "Lease Agreement",
        "file_type_id": "filetype-lease-agreement",
        "is_private": true
      }
    ],
    "date_of_birth": "1990-05-20T00:00:00Z",
    "email_1": "emily.johnson@example.com",
    "events": [
      {
        "x_type_id": "evt-001",
        "unit_id": "unit-101",
        "x_leasing_agent_id": "agent-789",
        "x_sub_type_id": "subtype-01",
        "x_result_id": "result-01",
        "event_datetime": "2024-06-10T14:00:00Z",
        "appointment_datetime": "2024-06-12T10:00:00Z",
        "time_from": "10:00",
        "time_to": "11:00",
        "notes": "Initial application review meeting",
        "title": "Application Review",
        "reasons_for_event": "Applicant screening"
      }
    ],
    "move_in_date": "2024-07-01T12:00:00Z",
    "phone_1": "+1-217-555-1234",
    "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-04-15",
        "is_house_broken": true,
        "special_provisions": "No special provisions"
      }
    ],
    "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": "PRMT-5678",
        "notes": "Resident parking permit required"
      }
    ],
    "employment_history": [
      {
        "income_type": "CURRENT_EMPLOYER",
        "frequency": "MONTHLY",
        "position": "Software Engineer",
        "name": "Tech Solutions Inc.",
        "phone": "+1-217-555-6789",
        "address_1": "456 Technology Drive",
        "address_2": "Suite 200",
        "address_3": "",
        "city": "Springfield",
        "state": "IL",
        "province": "",
        "zip": "62703",
        "country": "USA",
        "income_in_cents": 850000,
        "supervisor_first_name": "John",
        "supervisor_last_name": "Smith",
        "supervisor_phone": "+1-217-555-6790",
        "supervisor_email": "john.smith@techsolutions.com",
        "income_effective_date": "2023-01-01",
        "start_date": "2020-06-15",
        "end_date": ""
      }
    ],
    "add_ons": [
      {
        "rentable_item_id": "rentable-001",
        "employee_id": "emp-123",
        "start_date": "2024-07-01",
        "end_date": "2025-06-30"
      }
    ]
  }
}

Create Applicant: 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

address_1stringRequired

The first address line associated with the applicant

application_statusenumRequired

The status associated with the application

Allowed values:

citystringRequired

The city associated with the applicant

first_namestringRequired

The first name associated with the applicant

last_namestringRequired

The last name associated with the applicant

statestringRequired

The state associated with the applicant

zipstringRequired

The zip code associated with the applicant

unit_idstringOptional

The Propexo unique identifier for the unit

address_2stringOptional

The second address line associated with the applicant

attachmentslist of objectsOptional

Files to upload for 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

move_in_datestringOptionalformat: "date-time"

The move-in date associated with the applicant

phone_1stringOptional

Primary phone number 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