Query Realtime Appointment Availability: EliseAI

POST

/crm/v1/appointment-availability/eliseai/

POST

/crm/v1/appointment-availability/eliseai/

$ curl -X POST https://api.propexo.com/crm/v1/appointment-availability/eliseai/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
>   "community_id": "comm_1234567890abcdef",
>   "start_time": "2024-01-15T09:30:00Z",
>   "end_time": "2024-01-15T17:30:00Z"
> }'

1 {
2   "meta": {
3     "job_id": "job_20240115_093000_abcdef123456"
4   },
5   "result": [
6     {
7       "last_seen": "2024-01-14T22:00:00Z",
8       "calendar_type": "AGENT_CALENDAR",
9       "x_agent_id": "agent_7890abcd1234",
10       "agent_first_name": "Emily",
11       "agent_last_name": "Johnson",
12       "default_appointment_length": 30,
13       "minimum_appointment_lead_time": 60,
14       "timezone": "America/New_York",
15       "calendar_days": [
16         {
17           "date": "2024-01-15",
18           "day_of_week": "Monday",
19           "opening_time": "09:00:00",
20           "closing_time": "17:00:00",
21           "simultaneous_appointment_mode": "SINGLE",
22           "max_simultaneous_appointments": 1,
23           "available_slots": [
24             {
25               "start": "09:30:00",
26               "end": "10:00:00"
27             },
28             {
29               "start": "10:30:00",
30               "end": "11:00:00"
31             },
32             {
33               "start": "14:00:00",
34               "end": "14:30:00"
35             }
36           ]
37         }
38       ],
39       "x_community_id": "comm_1234567890abcdef",
40       "tour_type": "IN_PERSON"
41     }
42   ]
43 }

Query Realtime Appointment Availability: EliseAI

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

community_idstringRequired

The Propexo unique identifier for the community

start_timestringRequiredformat: "date-time"

The start of the time range to check for availability. This time should be specified in UTC.

end_timestringRequiredformat: "date-time"

The end of the time range to check for availability. This time should be specified in UTC.

tour_typeenumOptional

The type of tour to query availability for. If omitted, availability for all tour types will be returned as separate calendars distinguished by tour_type.

Response

Successful response

metaobject

resultlist of objects

Errors

400

Bad Request Error