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/unarchive the schedule. Cannot be combined with timebounds, deleteTimebounds, or a productMap assignment.

entity_id
string
location_id
string
config
object
timebounds
object

Rows to create or update. Same shape as on POST /schedule, except daily/repeat-weekly/repeat-daily/block entries may include a booking_id to update that existing row in place instead of creating a new one.

deleteTimebounds
object

booking_ids to delete, keyed by rule type. A booking_id used here cannot also appear in timebounds in the same request.

productMap
object

Assigns/unassigns this schedule to products. Keys are product-emr or product-widget, values are true/false. Requires entity_id and location_id to also be present in the request.

Response

OK

success
boolean
Example:

true

data
object