Skip to main content
POST
Create schedule

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
actorIds
string[]
required

References to Practitioner, Location, etc.

Required array length: 1 - 20 elements
active
boolean

Whether the schedule is active (default true)

serviceCategory
string[]
Maximum array length: 10
Maximum string length: 200
serviceType
string[]
Maximum array length: 10
Maximum string length: 200
specialty
string[]
Maximum array length: 10
Maximum string length: 200
planningHorizon
object
comment
string
Maximum string length: 2000

Response

Schedule created