Skip to main content
PATCH
Update Schedule

Headers

auth
string
required
Example:

"auth"

Path Parameters

scheduleId
string
required

Id of the schedule to update.

Body

application/json

At least one field must be provided.

name
string

New schedule name. If provided, must be non-empty.

archive
boolean

Archive or unarchive. Archiving deletes the time windows, blocks and bookable_by groups. Can't be mixed with timebounds, deleteTimebounds or bookable_by.

entity_id
string

Doctor id (clinic id for a clinic schedule). Needed with bookable_by.

location_id
string

Clinic id. Needed with bookable_by.

config
object
timebounds
object

Time windows to add or change. Same shape as on Create Schedule. A daily, repeat-weekly, repeat-daily or block entry with a booking_id changes that saved row instead of adding a new one.

deleteTimebounds
object

Saved rows to delete, as booking_ids per rule type. A booking_id here can't also be in timebounds in the same call.

bookable_by
object

Who can book on this schedule. true adds the group, false removes it. Needs entity_id and location_id in the same call.

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

OK

success
boolean
Example:

true

data
object