Create an Appointment

Create an appointment reservation.

SecurityapiKeyAuth and practiceGroupId
Request
Request Body schema: application/json
required
appointment_type_id
required
string^\d+$
location_id
required
string^\d+$
practitioner_id
required
string^\d+$
duration
required
number
start_time
required
string or null <date-time>

ISO 8601 date format

patient_id
string^\d+$
billpayer_id
string^\d+$
reason
string
suppress_mail
boolean
suppress_availability_check
boolean
Responses
200

Ok

400

Validation error

401

Unauthorised

404

Not found

500

Unknown error

post/v1/appointments
Request samples
application/json
{
  • "appointment_type_id": "string",
  • "location_id": "string",
  • "practitioner_id": "string",
  • "duration": 0,
  • "start_time": "1989-04-11",
  • "patient_id": "string",
  • "billpayer_id": "string",
  • "reason": "string",
  • "suppress_mail": true,
  • "suppress_availability_check": true
}
Response samples
application/json
{
  • "id": "string",
  • "reserved_until": "2019-08-24T14:15:22Z"
}