Confirm a booking

Confirms the booking at a concrete appointment time. The booking moves to Confirmed
with scheduledFor set, any outstanding proposal is cleared, and the member is
notified by email/SMS according to their notification preferences.

Member-agreement attestation: when the booking is currently RescheduleProposed,
the proposed time is still awaiting the member's acceptance in the app. Confirming in
that state moves the appointment without the member accepting through the platform, so
you must attest that the member agreed out-of-band (for example over the phone) by
sending memberAgreed: true — otherwise the request fails with 409
member_agreement_required. In other confirmable statuses memberAgreed is not
required.

A booking in the legacy Completed status cannot be confirmed (409 invalid_status).
The action is recorded in your activity log.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The booking's identifier.

Body Params
string
required
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}$

The appointment time in local clinic time, yyyy-MM-ddTHH:mm with no timezone offset.

boolean
Defaults to false

Attestation that the member agreed to this time out-of-band. Required (true) only when the booking is currently RescheduleProposed — confirming then moves the appointment without the member accepting in the app.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json