# Appointment Holds Short-lived slot reservations before payment and confirm ## POST /connected/appointment\_holds > ```json {"openapi":"3.2.0","info":{"title":"Dr.Online Connected API","version":"2026-05-29"},"tags":[{"name":"Appointment Holds","summary":"Appointment Holds","description":"Short-lived slot reservations before payment and confirm"}],"servers":[{"url":"http://localhost:3001/v1","description":"Live (production credentials)"},{"url":"http://localhost:3001/v1","description":"Sandbox (non-production credentials)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Connected API secret key from the credential reveal flow (`sk_live_…` or `sk_sandbox_…`). Each key is tied to one Dr.Online catalogue. Server-to-server only: `Authorization: Bearer `."}}},"paths":{"/connected/appointment_holds":{"post":{"operationId":"partnerV1CreateAppointmentHold","tags":["Appointment Holds"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"appointment_type_id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"practitioner_id":{"type":"string","description":"Practitioner id from `GET /practitioners`"},"start":{"type":"string","format":"date-time"},"contact_type":{"type":"string","enum":["phone_call","video_call","in_person"],"description":"{\"example\":\"video_call\"}"},"partner_reference":{"type":"string","maxLength":200,"description":"Optional partner-side reference stored on confirm"},"locale":{"type":"string","enum":["en","pt"],"description":"Request services in this language. When omitted, the default for the request context is used (e.g. widget language in the booking system, app default elsewhere)."},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Optional partner key-value strings stored on the appointment. Returned as `appointment.metadata` on the hold, after confirm, and on `GET /connected/appointments/{appointment_id}`."},"patient":{"type":"object","properties":{"first_name":{"type":"string","minLength":1,"description":"{\"example\":\"Alex\"}"},"last_name":{"type":"string","minLength":1,"description":"{\"example\":\"Smith\"}"},"email":{"type":"string","format":"email","description":"{\"example\":\"alex@partner.example\"}"},"phone":{"type":"string","description":"{\"example\":\"+447700900123\"}"},"sex":{"type":"string","enum":["male","female"],"description":"{\"example\":\"male\"}"},"date_of_birth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"ISO 8601 calendar date (`YYYY-MM-DD`). Stored on the patient record when provided on hold or confirm."},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Set of key-value pairs (strings). Pass an empty string as the value to remove a key on update."}},"required":["first_name","last_name","email"],"additionalProperties":false,"description":"Optional. When provided, creates or updates the patient on our side for this hold (same shape as confirm `patient`)."}},"required":["appointment_type_id","practitioner_id","start"],"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appointment_hold":{"type":"object","properties":{"id":{"type":"string","description":"Hold id returned when creating an appointment hold"},"object":{"type":"string","enum":["appointment_hold"]},"appointment":{"type":"object","properties":{"id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"object":{"type":"string","enum":["appointment"]},"appointment_hold_id":{"type":"string","nullable":true,"description":"Hold id from `POST /appointment_holds` when available."},"appointment_id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"appointment_type_id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"cancelled_at":{"type":"string","nullable":true,"description":"When the appointment was cancelled in our system (`null` if not cancelled)."},"confirmed_at":{"type":"string","nullable":true,"description":"When the appointment was confirmed via the Connected API (`null` while held)."},"contact_type":{"type":"string","enum":["phone_call","video_call","in_person"],"description":"{\"example\":\"video_call\"}"},"created_at":{"type":"string","description":"When the appointment record was created in our system."},"end":{"type":"string","format":"date-time"},"external_payment_reference":{"type":"string","minLength":1,"maxLength":200,"description":"Your PSP reference from confirm (`null` while held).","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"partner_reference":{"type":"string","maxLength":200,"description":"Optional partner reference from confirm (`null` if unset).","nullable":true},"patient":{"type":"object","properties":{"id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"object":{"type":"string","enum":["patient"]},"date_of_birth":{"type":"string","nullable":true,"description":"ISO 8601 date when known (`null` otherwise)."},"email":{"type":"string","format":"email","description":"{\"example\":\"alex@partner.example\"}"},"first_name":{"type":"string","description":"{\"example\":\"Alex\"}"},"last_name":{"type":"string","description":"{\"example\":\"Smith\"}"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"patient_id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"phone":{"type":"string","nullable":true,"description":"{\"example\":\"+447700900123\"}"},"sex":{"type":"string","enum":["male","female"],"nullable":true,"description":"{\"example\":\"male\"}"}},"required":["id","object","date_of_birth","email","first_name","last_name","patient_id","phone","sex"],"additionalProperties":false,"nullable":true,"description":"Included on `GET /connected/appointments/{appointment_id}` when available. Omitted on list responses."},"patient_id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"practitioner_id":{"type":"string","description":"Practitioner id from `GET /practitioners`"},"previous_end":{"type":"string","nullable":true,"description":"Previous scheduled end before the latest reschedule (`null` if never rescheduled)."},"previous_start":{"type":"string","nullable":true,"description":"Previous scheduled start before the latest reschedule (`null` if never rescheduled)."},"questionnaire":{"type":"object","properties":{"id":{"type":"string","description":"Dr.Online questionnaire id — use `GET /connected/questionnaires/{questionnaire_id}` or the appointment sub-resource."},"object":{"type":"string","enum":["questionnaire"]},"completion_url":{"type":"string","format":"uri","nullable":true},"name":{"type":"string"},"questionnaire_id":{"type":"string","description":"Dr.Online questionnaire id — use `GET /connected/questionnaires/{questionnaire_id}` or the appointment sub-resource."},"status":{"type":"string","enum":["open","finished","incomplete"]}},"required":["id","object","completion_url","name","questionnaire_id","status"],"additionalProperties":false,"nullable":true,"description":"Included on `GET /connected/appointments/{appointment_id}` when a pre-appointment questionnaire applies. Omitted on list responses."},"rescheduled":{"type":"boolean","description":"{\"example\":false}"},"rescheduled_at":{"type":"string","nullable":true,"description":"When the appointment was last rescheduled (`null` if never)."},"start":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["held","confirmed","cancelled"],"description":"{\"example\":\"held\"}"},"timezone":{"type":"string","enum":["Europe/London","Europe/Lisbon","Europe/Dublin"],"description":"{\"example\":\"Europe/London\"}"},"updated_at":{"type":"string","nullable":true,"description":"When the appointment record was last updated (`null` if unknown)."},"video_url":{"type":"string","format":"uri","nullable":true,"description":"Video consultation join URL when confirmed and contact type is video (`null` otherwise)."}},"required":["id","object","appointment_hold_id","appointment_id","appointment_type_id","booking_channel_id","cancelled_at","confirmed_at","contact_type","created_at","end","external_payment_reference","partner_reference","patient_id","practitioner_id","previous_end","previous_start","rescheduled","rescheduled_at","start","status","timezone","updated_at","video_url"],"additionalProperties":false},"appointment_hold_id":{"type":"string","description":"Hold id returned when creating an appointment hold"},"appointment_id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"expires_at":{"type":"string","description":"ISO 8601 UTC timestamp"},"hold_token":{"type":"string","nullable":true,"description":"Opaque hold token (returned on create only; `null` on retrieve)."},"partner_reference":{"type":"string","maxLength":200,"description":"Optional partner-side reference stored on confirm","nullable":true}},"required":["id","object","appointment","appointment_hold_id","appointment_id","booking_channel_id","expires_at","hold_token","partner_reference"],"additionalProperties":false}},"required":["appointment_hold"],"additionalProperties":false}}}}}}}}} ``` ## GET /connected/appointment\_holds/{appointment\_hold\_id} > ```json {"openapi":"3.2.0","info":{"title":"Dr.Online Connected API","version":"2026-05-29"},"tags":[{"name":"Appointment Holds","summary":"Appointment Holds","description":"Short-lived slot reservations before payment and confirm"}],"servers":[{"url":"http://localhost:3001/v1","description":"Live (production credentials)"},{"url":"http://localhost:3001/v1","description":"Sandbox (non-production credentials)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Connected API secret key from the credential reveal flow (`sk_live_…` or `sk_sandbox_…`). Each key is tied to one Dr.Online catalogue. Server-to-server only: `Authorization: Bearer `."}}},"paths":{"/connected/appointment_holds/{appointment_hold_id}":{"get":{"operationId":"partnerV1GetAppointmentHold","tags":["Appointment Holds"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"appointment_hold_id","required":true,"description":"Hold id returned when creating an appointment hold"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appointment_hold":{"type":"object","properties":{"id":{"type":"string","description":"Hold id returned when creating an appointment hold"},"object":{"type":"string","enum":["appointment_hold"]},"appointment":{"type":"object","properties":{"id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"object":{"type":"string","enum":["appointment"]},"appointment_hold_id":{"type":"string","nullable":true,"description":"Hold id from `POST /appointment_holds` when available."},"appointment_id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"appointment_type_id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"cancelled_at":{"type":"string","nullable":true,"description":"When the appointment was cancelled in our system (`null` if not cancelled)."},"confirmed_at":{"type":"string","nullable":true,"description":"When the appointment was confirmed via the Connected API (`null` while held)."},"contact_type":{"type":"string","enum":["phone_call","video_call","in_person"],"description":"{\"example\":\"video_call\"}"},"created_at":{"type":"string","description":"When the appointment record was created in our system."},"end":{"type":"string","format":"date-time"},"external_payment_reference":{"type":"string","minLength":1,"maxLength":200,"description":"Your PSP reference from confirm (`null` while held).","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"partner_reference":{"type":"string","maxLength":200,"description":"Optional partner reference from confirm (`null` if unset).","nullable":true},"patient":{"type":"object","properties":{"id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"object":{"type":"string","enum":["patient"]},"date_of_birth":{"type":"string","nullable":true,"description":"ISO 8601 date when known (`null` otherwise)."},"email":{"type":"string","format":"email","description":"{\"example\":\"alex@partner.example\"}"},"first_name":{"type":"string","description":"{\"example\":\"Alex\"}"},"last_name":{"type":"string","description":"{\"example\":\"Smith\"}"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"patient_id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"phone":{"type":"string","nullable":true,"description":"{\"example\":\"+447700900123\"}"},"sex":{"type":"string","enum":["male","female"],"nullable":true,"description":"{\"example\":\"male\"}"}},"required":["id","object","date_of_birth","email","first_name","last_name","patient_id","phone","sex"],"additionalProperties":false,"nullable":true,"description":"Included on `GET /connected/appointments/{appointment_id}` when available. Omitted on list responses."},"patient_id":{"type":"string","description":"Patient id — use `GET /patients/{patient_id}` (Care API) for demographics"},"practitioner_id":{"type":"string","description":"Practitioner id from `GET /practitioners`"},"previous_end":{"type":"string","nullable":true,"description":"Previous scheduled end before the latest reschedule (`null` if never rescheduled)."},"previous_start":{"type":"string","nullable":true,"description":"Previous scheduled start before the latest reschedule (`null` if never rescheduled)."},"questionnaire":{"type":"object","properties":{"id":{"type":"string","description":"Dr.Online questionnaire id — use `GET /connected/questionnaires/{questionnaire_id}` or the appointment sub-resource."},"object":{"type":"string","enum":["questionnaire"]},"completion_url":{"type":"string","format":"uri","nullable":true},"name":{"type":"string"},"questionnaire_id":{"type":"string","description":"Dr.Online questionnaire id — use `GET /connected/questionnaires/{questionnaire_id}` or the appointment sub-resource."},"status":{"type":"string","enum":["open","finished","incomplete"]}},"required":["id","object","completion_url","name","questionnaire_id","status"],"additionalProperties":false,"nullable":true,"description":"Included on `GET /connected/appointments/{appointment_id}` when a pre-appointment questionnaire applies. Omitted on list responses."},"rescheduled":{"type":"boolean","description":"{\"example\":false}"},"rescheduled_at":{"type":"string","nullable":true,"description":"When the appointment was last rescheduled (`null` if never)."},"start":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["held","confirmed","cancelled"],"description":"{\"example\":\"held\"}"},"timezone":{"type":"string","enum":["Europe/London","Europe/Lisbon","Europe/Dublin"],"description":"{\"example\":\"Europe/London\"}"},"updated_at":{"type":"string","nullable":true,"description":"When the appointment record was last updated (`null` if unknown)."},"video_url":{"type":"string","format":"uri","nullable":true,"description":"Video consultation join URL when confirmed and contact type is video (`null` otherwise)."}},"required":["id","object","appointment_hold_id","appointment_id","appointment_type_id","booking_channel_id","cancelled_at","confirmed_at","contact_type","created_at","end","external_payment_reference","partner_reference","patient_id","practitioner_id","previous_end","previous_start","rescheduled","rescheduled_at","start","status","timezone","updated_at","video_url"],"additionalProperties":false},"appointment_hold_id":{"type":"string","description":"Hold id returned when creating an appointment hold"},"appointment_id":{"type":"string","description":"Appointment (booking) id returned when creating a hold"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"expires_at":{"type":"string","description":"ISO 8601 UTC timestamp"},"hold_token":{"type":"string","nullable":true,"description":"Opaque hold token (returned on create only; `null` on retrieve)."},"partner_reference":{"type":"string","maxLength":200,"description":"Optional partner-side reference stored on confirm","nullable":true}},"required":["id","object","appointment","appointment_hold_id","appointment_id","booking_channel_id","expires_at","hold_token","partner_reference"],"additionalProperties":false}},"required":["appointment_hold"],"additionalProperties":false}}}}}}}}} ``` ## POST /connected/appointment\_holds/{appointment\_hold\_id}/release > ```json {"openapi":"3.2.0","info":{"title":"Dr.Online Connected API","version":"2026-05-29"},"tags":[{"name":"Appointment Holds","summary":"Appointment Holds","description":"Short-lived slot reservations before payment and confirm"}],"servers":[{"url":"http://localhost:3001/v1","description":"Live (production credentials)"},{"url":"http://localhost:3001/v1","description":"Sandbox (non-production credentials)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Connected API secret key from the credential reveal flow (`sk_live_…` or `sk_sandbox_…`). Each key is tied to one Dr.Online catalogue. Server-to-server only: `Authorization: Bearer `."}}},"paths":{"/connected/appointment_holds/{appointment_hold_id}/release":{"post":{"operationId":"partnerV1ReleaseAppointmentHold","tags":["Appointment Holds"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"appointment_hold_id","required":true,"description":"Hold id returned when creating an appointment hold"}],"responses":{"200":{"description":"Default Response"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.dronline.uk/connected-api/appointment-holds.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.