Create Applicant Event: Yardi REST

Beta

POST

/v1/events/applicants/yardi_rest/

POST

/v1/events/applicants/yardi_rest/

curl -X POST https://api.propexo.com/v1/events/applicants/yardi_rest/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
  "applicant_id": "app_1234567890abcdef",
  "event_name": "CallToProspect",
  "event_datetime": "2024-01-15T09:30:00Z",
  "agent_name": "Jessica Martinez"
}'

{
  "meta": {
    "job_id": "job_20240115093000_abcdef123456"
  },
  "result": {
    "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
    "applicant_id": "app_1234567890abcdef",
    "unit_id": "unit_9876543210fedcba",
    "event_name": "CallToProspect",
    "event_datetime": "2024-01-15T09:30:00Z",
    "agent_name": "Jessica Martinez",
    "notes": "Initial call to discuss apartment availability and leasing options.",
    "rent_amount_in_cents": 0
  }
}

Create Applicant Event: Yardi REST

Interface	Method
ILS Guest Card	/ItfProspect/ImportYardiGuest

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

applicant_idstringRequired

The Propexo unique identifier for the applicant

event_nameenumRequired

The name or type of event

event_datetimestringRequiredformat: "date-time"

The date when the event will occur

agent_namestringRequired

The name of the leasing agent associated with the event

unit_idstringOptional

The Propexo unique identifier for the unit. Only some PMS events use this, including "Show" and "Appointment"

notesstringOptional<=256 characters

Notes associated with the event

rent_amount_in_centsdoubleOptional>=0

The rent amount in cents for the event. Required for LeaseSign event

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error