Create Lead Appointment: Yardi | Propexo

curl -X POST https://api.propexo.com/v1/events/appointments/leads/yardi/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8e7d6c5b4a3",
  "lead_id": "lead-1234567890abcdef",
  "unit_id": "unit-0987654321fedcba",
  "employee_id": "emp-1122334455667788",
  "appointment_date": "2024-07-10",
  "appointment_time": "14:30:00"
}'

{
  "meta": {
    "job_id": "job-20240710-143000-xyz"
  },
  "result": {
    "integration_id": "intg-9f8e7d6c5b4a3",
    "lead_id": "lead-1234567890abcdef",
    "unit_id": "unit-0987654321fedcba",
    "employee_id": "emp-1122334455667788",
    "appointment_date": "2024-07-10",
    "appointment_time": "14:30:00",
    "notes": "Initial tour scheduled for interested lead."
  }
}

Create an appointment for a lead in Yardi. Yardi interprets appointment date and time as being in the timezone of the property.

Those can be read in our /timezones endpoint.

If the property doesn’t have a specific timezone configured, there will be an integration global timezone record that should be used in that case.

The time for this record is based on the Yardi server’s configured timezone.

In the case that the Yardi server time is different than the current time, we provide the server_time_error_seconds field on the /timezones endpoint as well.

Interface	Method
ILS Guest Card	ImportYardiGuest_Login

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Create an appointment for a lead in Yardi. Yardi interprets appointment date and time as being in the timezone of the property. Those can be read in our `/timezones` endpoint. If the property doesn't have a specific timezone configured, there will be an integration global timezone record that should be used in that case. The time for this record is based on the Yardi server's configured timezone. In the case that the Yardi server time is different than the current time, we provide the `server_time_error_seconds` field on the `/timezones` endpoint as well. | Interface | Method | |---|---| | ILS Guest Card | ImportYardiGuest_Login | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</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

lead_idstringRequired

The Propexo unique identifier for the lead

unit_idstringRequired

The Propexo unique identifier for the unit

employee_idstringRequired

The Propexo unique identifier for the employee

appointment_datestringRequired

The date when the appointment will occur

appointment_timestringRequiredformat: "(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)"

The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones

notesstringOptional<=256 characters

Notes associated with the event

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error