ENendless
Patient Appointments

Schedule Appointment

Schedule a new appointment for a patient.

post/api/v3/patient-appointments/{patient_id}

Request

  • Base URL
    https://api.endless.health (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

patient_idinteger required

Request body

coach_idinteger required
start_timestring date-time nullable
end_timestring date-time nullable
timezonestring nullable
is_availableboolean
status'SCHEDULED' | 'CANCELED' | 'NOT_ATTENDED' | 'RESCHEDULED'
titlestring nullable
descriptionstring nullable
locationstring nullable
is_recurringboolean
recurrence_rulestring nullable
max_bookingsinteger nullable
booking_durationinteger nullable
notesstring nullable

Response

Successful Response

coach_idinteger required
start_timestring date-time nullable
end_timestring date-time nullable
timezonestring nullable
is_availableboolean
status'SCHEDULED' | 'CANCELED' | 'NOT_ATTENDED' | 'RESCHEDULED'
titlestring nullable
descriptionstring nullable
locationstring nullable
is_recurringboolean
recurrence_rulestring nullable
max_bookingsinteger nullable
booking_durationinteger nullable
notesstring nullable
idinteger required
user_idinteger required
external_calendar_idstring nullable
external_event_idstring nullable
meeting_linkstring nullable
cancel_linkstring nullable
reschedule_linkstring nullable
coach_namestring nullable
session_numberinteger nullable
upcoming_session_statusstring nullable
attendedboolean nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.