Skip to main content
POST
/
v1
/
practitioner-roles
Create practitioner role
curl --request POST \
  --url https://api.clinikapi.com/v1/practitioner-roles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "practitionerId": "<string>",
  "role": "<string>",
  "organizationName": "<string>",
  "specialty": [
    "<string>"
  ],
  "locationName": "<string>",
  "phone": "<string>",
  "email": "[email protected]",
  "period": {
    "start": "<string>",
    "end": "<string>"
  },
  "availableTime": [
    {
      "daysOfWeek": [],
      "allDay": true,
      "availableStartTime": "<string>",
      "availableEndTime": "<string>"
    }
  ],
  "notAvailable": [
    {
      "description": "<string>",
      "during": {
        "start": "<string>",
        "end": "<string>"
      }
    }
  ],
  "availabilityExceptions": "<string>",
  "availableDays": [],
  "availableStartTime": "<string>",
  "availableEndTime": "<string>"
}
'

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
practitionerId
string
required
role
string
required

Role code (doctor, nurse, pharmacist, admin, consultant)

Maximum string length: 100
organizationName
string
Maximum string length: 200
specialty
string[]
locationName
string
Maximum string length: 200
phone
string
email
string<email>
period
object

Period during which the role is valid

availableTime
object[]

Multiple availability schedules

notAvailable
object[]

Periods when the practitioner is not available

availabilityExceptions
string

Free-text description of availability exceptions

Maximum string length: 1000
availableDays
enum<string>[]

Legacy: use availableTime instead

Available options:
mon,
tue,
wed,
thu,
fri,
sat,
sun
availableStartTime
string

Legacy: use availableTime instead

availableEndTime
string

Legacy: use availableTime instead

Response

201

Practitioner role created