Registrations

Update a registration (call / move / complete)

Advance the visit lifecycle: waiting → on_hold → serving → checkout → completed.

Requires the registrations:write scope.

patch/v1/registrations/{lead_pid}

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/registrations/:lead_pid/patch.ts
A function with typed inputs. Its response is checked against the schema.

lead_pidstring required

The lead's opaque public id (pid), not the numeric id.

status'waiting' | 'on_hold' | 'serving' | 'checkout' | 'completed'

seatinteger

checkout_notestring

Updated

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