EvaSay has its own booking calendar: agents with the booking functions check free times, book and cancel on it during calls and chats, and your team sees it on the Appointments page. The API works on the same calendar, so your website, booking system or front desk can use it too. Its open days and hours, the length of a booking and the staff are set under Appointments → Booking hours; dates and times are in the calendar's time zone.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/voice/appointments/availability?date=2030-01-07 | The free start times that day; staff for one person's |
| GET | /api/v1/voice/appointments?from=2030-01-07&days=7 | The appointments from that day on (days up to 31), with the calendar's settings |
| POST | /api/v1/voice/appointments | Book an appointment |
| GET | /api/v1/voice/appointments/{id} | One appointment |
| PATCH | /api/v1/voice/appointments/{id} | Change its status, notes or service |
curl https://evasay.com/api/v1/voice/appointments \
-X POST \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "date": "2030-01-07", "time": "10:00", "name": "Ana Silva", "phone": "+14155550123", "service": "Haircut" }'
date, time and name are required; phone, email, service, staff and notes are optional. A booking follows the agent's rules: the calendar must be open then, and someone must be free, either the staff member asked for or, without one, anyone (without staff, the business takes one booking at a time). A time that is taken, or outside the open hours, answers 409 with the code appointment_conflict. A phone number in international format links the booking to that customer, or adds them to your customers. The answer is the appointment, with source api.
An appointment is booked, completed (visited), no_show or cancelled; one waiting for a place is waitlisted. Mark the visit afterwards:
{ "status": "completed" }
A completed visit counts on the customer's visits. Cancelling a booking frees its time; when it is more than 15 minutes away, the first person on the waitlist for that time is booked into it. A waitlisted appointment can only be cancelled. Your systems hear of bookings as they happen through the appointment.created and appointment.updated webhook events.