Skip to main content
POST
Reserve a slot

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Body

application/json
slot_token
string
required

A slot_token from a slot search, passed verbatim.

Required string length: 1 - 8192
patient_id
string<uuid>

The patient, as returned by POST /patients. Required only when the slot_token names no patient — that is, when the slot search did not send patient_id. Otherwise optional: a matching value is accepted, and a different one is a 400 (slot_token.patient_mismatch).

Response

The slot is held.

A short-lived reservation on one slot. While it is live the slot is no longer offered.

reservation_id
string<uuid>
required

Confirm with this id, or release it.

expires_at
string<date-time>
required

When the reservation lapses and the slot is offered again.

start
string<date-time>
required
end
string<date-time>
required
appointment_type_id
string<uuid>
duration_minutes
integer