Skip to main content
POST
/
v1
/
slots
Create slot
curl --request POST \
  --url https://api.clinikapi.com/v1/slots \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "scheduleId": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "serviceCategory": "<string>",
  "serviceType": "<string>",
  "specialty": "<string>",
  "appointmentType": "<string>",
  "overbooked": true,
  "comment": "<string>"
}
'

Authorizations

​
x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
​
scheduleId
string
required

The schedule this slot belongs to

​
status
enum<string>
required
Available options:
busy,
free,
busy-unavailable,
busy-tentative
​
start
string<date-time>
required
​
end
string<date-time>
required
​
serviceCategory
string
Maximum string length: 200
​
serviceType
string
Maximum string length: 200
​
specialty
string
Maximum string length: 200
​
appointmentType
string
Maximum string length: 200
​
overbooked
boolean
​
comment
string
Maximum string length: 2000

Response

201

Slot created