Skip to main content
POST
/
v1
/
healthcare-services
Create healthcare service
curl --request POST \
  --url https://api.clinikapi.com/v1/healthcare-services \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "active": true,
  "providedById": "<string>",
  "category": [
    "<string>"
  ],
  "type": [
    "<string>"
  ],
  "specialty": [
    "<string>"
  ],
  "locationNames": [
    "<string>"
  ],
  "comment": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "appointmentRequired": true,
  "availableTime": [
    {
      "daysOfWeek": [],
      "allDay": true,
      "availableStartTime": "<string>",
      "availableEndTime": "<string>"
    }
  ],
  "notAvailable": [
    {
      "description": "<string>",
      "during": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "availabilityExceptions": "<string>",
  "program": [
    "<string>"
  ],
  "referralMethod": [
    "<string>"
  ],
  "communication": [
    "<string>"
  ]
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
name
string
required
Maximum string length: 500
active
boolean
providedById
string

Organization that provides this service

category
string[]
type
string[]
specialty
string[]
locationNames
string[]
comment
string
Maximum string length: 2000
phone
string
email
string
appointmentRequired
boolean
availableTime
object[]
notAvailable
object[]
availabilityExceptions
string
Maximum string length: 1000
program
string[]
referralMethod
string[]
communication
string[]

Response

201

Healthcare service created