Skip to main content
POST
Create appointment

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
proposed,
pending,
booked,
arrived,
fulfilled,
cancelled,
noshow,
checked-in,
waitlist
patientId
string
required
practitionerId
string
start
string<date-time>
end
string<date-time>
minutesDuration
integer
Required range: x <= 1440
appointmentType
string

Type of appointment (routine, walkin, urgent, followup)

Maximum string length: 100
serviceType
string

Service being booked (e.g. cardiology consultation)

Maximum string length: 200
serviceCategory
string

Service category (general-practice, specialist, dental)

Maximum string length: 200
specialty
string

Required specialty (e.g. cardiology, dermatology)

Maximum string length: 200
reasonCode
string

Reason for the appointment

Maximum string length: 500
priority
integer

0 = routine, 1-9 = increasing urgency

Required range: 0 <= x <= 9
description
string

Shown on a subject line in a meeting request

Maximum string length: 2000
comment
string
Maximum string length: 2000
patientInstruction
string

Instructions for the patient (e.g. fast for 12 hours)

Maximum string length: 2000
cancelationReason
string

Reason for cancellation (when status is cancelled/noshow)

Maximum string length: 500
basedOnId
string

ServiceRequest ID this appointment is allocated to assess

requestedPeriod
object[]

Preferred time windows for the appointment

created
string<date-time>

When the appointment was initially created (defaults to now)

Response

201

Appointment created