Appointments

Return appointments in a time window with their customer and status.

Returns appointments between startAt and endAt, earliest first, each with its customer, slot and status. Use it to check what is already booked before offering a time, or to list today's schedule. With no window it returns the next 30 days; a window longer than 92 days is refused. Paginated by window rather than by cursor: narrow startAt and endAt to page through, and check meta.window.truncated to see whether the row limit cut the answer short. Read-only and rate-limited to 20 calls per minute.

Create an appointment for a customer in a specific slot.

Books a slot with a title, start and end. Use it once the customer has confirmed the time — check appointments.list first so you do not offer a taken slot. Writes a booking and reports any conflicting appointment in the same slot; it does not message the customer, so tell them yourself with messages.send.

Permanently erase an appointment record.

Deletes the appointment outright. This cannot be undone, and it destroys the history — to record that a booking was called off, set its status to CANCELLED with appointments.update instead. Requires the separate appointments:delete scope and is limited to 5 calls per minute.

Change an appointment’s time, title, customer or status.

Updates the fields you send. Use it to reschedule, or to set the status to COMPLETED, CANCELLED or NO_SHOW. Cancelling this way keeps the record, which is what you almost always want — appointments.delete erases it. Writes only; the customer is not notified.