Create Resident Event: Entrata | Propexo

curl -X POST https://api.propexo.com/v1/events/residents/entrata/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-987654321",
  "resident_id": "res-123456789",
  "event_type_id": "evt-202401",
  "event_datetime": "2024-01-15T09:30:00-07:00"
}'

{
  "meta": {
    "job_id": "job-20240115-001"
  },
  "result": {
    "integration_id": "intg-987654321",
    "resident_id": "res-123456789",
    "event_type_id": "evt-202401",
    "event_result_id": "reslt-1001",
    "event_sub_type_id": "subtype-2002",
    "employee_id": "emp-5551234",
    "unit_id": "unit-101A",
    "event_datetime": "2024-01-15T09:30:00-07:00",
    "reasons_for_event": "Scheduled maintenance inspection",
    "notes": "Resident notified via email and phone call.",
    "appointment_datetime": "2024-01-15T10:00:00-07:00",
    "time_from": "10:00:00",
    "time_to": "11:00:00",
    "title": "Maintenance Inspection",
    "call_phone_number_from": "+14075551234",
    "call_phone_number_to": "+14075559876",
    "call_status": "ANSWER",
    "call_duration": 300,
    "call_audio_link": "https://recordings.example.com/call12345.mp3",
    "email_body": "Dear Resident, your maintenance inspection is scheduled for January 15th at 10 AM.",
    "email_subject": "Maintenance Inspection Scheduled",
    "email_from": "maintenance@apartmentcomplex.com",
    "email_to": "resident.email@example.com",
    "email_cc": "manager@apartmentcomplex.com",
    "email_bcc": "audit@apartmentcomplex.com",
    "email_send": true
  }
}

Method
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.

Create an event for an applicant in Entrata. Entrata expects all times to be in Mountain Time (UTC-7:00 or UTC-6:00 depending on daylight savings). Times will be automatically converted based on the local time of the property when an end user views the event time in the browser. | Method | |---| | 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>

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

resident_idstringRequired

The Propexo unique identifier for the resident

event_type_idstringRequired

The Propexo unique identifier for the event type. Not all event types are currently supported. Contact Propexo support if there's an event type you'd like supported.

event_datetimestringRequiredformat: "date-time"

The date when the event will occur

event_result_idstringOptional

The Propexo unique identifier for the event result

event_sub_type_idstringOptional

The Propexo unique identifier for the event sub type

employee_idstringOptional

The Propexo unique identifier for the employee

unit_idstringOptional

The Propexo unique identifier for the unit

reasons_for_eventstringOptional

The reasons for the event

notesstringOptional

Notes associated with the event

appointment_datetimestringOptionalformat: "date-time"

The date when the appointment will occur

time_fromstringOptional

time_tostringOptional

titlestringOptional

The title associated with the event

call_phone_number_fromstringOptional

The phone number that the call was made from. Required for call event types.

call_phone_number_tostringOptional

The phone number that the call was received on. Required for call event types.

call_statusenumOptional

The status of the call. Required for call event types.

call_durationintegerOptional0-86400

The duration of the call in seconds. Required for call event types.

call_audio_linkstringOptionalformat: "uri"

The URL of the audio file for the call. This can be any valid URL and doesn't necessarily need to link to a audio file. Required for call event types.

email_bodystringOptional

The body of the email.

email_subjectstringOptional

The subject of the email.

email_fromstringOptional

The email address that the email was sent from. Required for email outgoing event types.

email_tostringOptional

The email address that the email was sent to. If specified, this must be the same email address as the resident's primary email address

email_ccstringOptional

The carbon copy email address that the email was sent to.

email_bccstringOptional

The blind carbon copy email address that the email was sent to.

email_sendbooleanOptional

Whether the email should be sent.

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error