Propose a different time

Proposes a replacement appointment time to the member. The booking moves to
RescheduleProposed with proposedFor (and the optional note) set, and the member
is notified and asked to accept or decline in the app. When the member accepts, the
booking becomes Confirmed at the proposed time; use this endpoint rather than
reschedule whenever the member has not already agreed to the new time.

A booking in the legacy Completed status cannot be rescheduled (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 time you are proposing, in local clinic time, yyyy-MM-ddTHH:mm with no timezone offset.

string
length ≤ 500

An optional message shown to the member with the proposal. At most 500 characters.

Responses

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