Skip to main content
POST
/
v1
/
schedules
Create schedule
curl --request POST \
  --url https://api.clinikapi.com/v1/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "actorIds": [
    "<string>"
  ],
  "active": true,
  "serviceCategory": [
    "<string>"
  ],
  "serviceType": [
    "<string>"
  ],
  "specialty": [
    "<string>"
  ],
  "planningHorizon": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "comment": "<string>"
}
'
{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "issues": [
    {
      "severity": "<string>",
      "code": "<string>",
      "diagnostics": "<string>"
    }
  ]
}

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