Appointments

Update / reschedule / cancel

To reschedule, send a new start. To cancel, send status: cancelled (+ optional cancelled_reason).

Requires the appointments:write scope.

patch/v1/appointments/{id}

Request

Base URL
https://developer.yezza.com
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/yezza/apis/yezza-clinic-api-external-access/docs/v1/appointments/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

startstring

New slot datetime — this is how you RESCHEDULE. date/time not accepted on update.

providerinteger

serviceinteger

leadobject

Edit lead details (name, phone, email, ic, address, remarks).

remarksstring

cancelled_reasonstring

Persists only with status=cancelled

ignore_rulesstring[]

Updated

No recorded changes to this operation across all 1 revision of this API.