Skip to main content

Sync appointment data

Goal (and why this page is short)​

If you're looking to read, create, or sync Appointment records through the Zentake API. You can't, today.

Not available via the public API

Appointment is part of Zentake's scheduling domain, but it is not currently exposed as a resource in the public REST API. No endpoint under /v2 reads, creates, or syncs appointments. Appointment-driven sends are configured as a workflow inside the Zentake dashboard, not via API calls.

What's actually available​

The complete set of /v2 resources is Documents, Export CSV, Forms, Messages, Packets, Packet Response downloads, Patients (including CSV batch upload), Responses, and Webhooks, see the API Reference for the full list. None of these represent a scheduled visit.

Workarounds​

  • Trigger sends from your own scheduling system. If your EHR or scheduling tool already fires a webhook or event when a visit is booked, have that system call Send an intake packet to a patient (POST /v2/messages) directly. Zentake doesn't need appointment data to send a Packet, only a patient id and a packet/form/document.
  • Schedule the Message for a specific time instead of "before the appointment." POST /v2/messages accepts scheduled_at, so if you know the visit time from your own system, you can schedule the intake send for, say, 24 hours before it, without Zentake needing to know about the appointment itself.
  • Keep appointment data in your system of record. Nothing in the Zentake API prevents you from correlating a patient id with your own appointment records outside of Zentake; there's just no field or endpoint here to store or fetch that correlation.

See also​