Create Appointment: EliseAI

POST

/crm/v1/appointments/eliseai

POST

/crm/v1/appointments/eliseai

$ curl -X POST https://api.propexo.com/crm/v1/appointments/eliseai \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
>   "appointment_date": "2024-01-15T09:30:00Z",
>   "appointment_time": "14:30:00"
> }'

1 {
2   "meta": {
3     "job_id": "job_1234567890abcdef"
4   },
5   "result": {
6     "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
7     "community_id": "comm_abcdef1234567890",
8     "prospect_id": "pros_0987654321fedcba",
9     "appointment_date": "2024-01-15T09:30:00Z",
10     "appointment_time": "14:30:00",
11     "email_1": "jane.doe@example.com",
12     "phone_1": "+14155552671",
13     "first_name": "Jane",
14     "last_name": "Doe",
15     "move_in_date": "2024-02-01",
16     "rent_minimum_in_cents": 120000,
17     "rent_maximum_in_cents": 180000,
18     "notes": "Prospect prefers a quiet unit with a balcony.",
19     "desired_num_bedrooms": [
20       2
21     ],
22     "tour_type": "IN_PERSON",
23     "lease_term_in_months": 12
24   }
25 }

Creates an appointment in EliseAI. When prospect_id is provided, books an appointment for an existing prospect. Otherwise, creates a new prospect with an appointment.

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

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. This time should be specified in UTC

community_idstringOptional

The Propexo unique identifier for the community

prospect_idstringOptional

The Propexo unique identifier for the prospect. When provided, books an appointment for an existing prospect. When omitted, creates a new prospect with an appointment.

email_1stringOptional

The primary email address associated with the prospect

phone_1stringOptionalformat: "^\+?\d{1,50}$"

Primary phone number associated with the prospect

first_namestringOptional

The first name associated with the prospect

last_namestringOptional

The last name associated with the prospect

move_in_datestringOptional

The move-in date associated with the prospect

rent_minimum_in_centsintegerOptional>=1

The minimum rent of the prospect

rent_maximum_in_centsintegerOptional>=1

The maximum rent of the prospect

notesstringOptional<=1000 characters

Notes associated with the event

desired_num_bedroomslist of integersOptional

The number of bedrooms associated with the prospect. Only the first value is sent to EliseAI. 0 represents a studio unit.

tour_typeenumOptional

The type of appointment being scheduled.

lease_term_in_monthsintegerOptional>=1

The amount of months for the lease term

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error