Skip to main content
POST
Create Schedule

Headers

auth
string
required
Example:

"auth"

Body

application/json
name
string
required

Schedule name. Required, non-empty.

entity_id
string

Doctor id. For a clinic schedule, the clinic id.

location_id
string

Clinic id.

config
object
timebounds
object

Availability rules to create alongside the schedule. Each block below is independent — include only the rule types you need.

bookable_by
object

Who can book on this schedule. true adds the group, false removes it. Needs entity_id and location_id (400 without them).

productMap
object
deprecated

Deprecated, will be removed soon. Use bookable_by. Same thing with internal keys: product-widget = patient, product-emr = front_desk, product-ipd = ipd. Sending it with bookable_by returns 400.

Response

Created

success
boolean
Example:

true

data
object