Skip to content

Update a schedule (partial)

PATCH
/appointments/schedules/{schedule_id}

Partially update a schedule. Pass only the fields to change.

  • name / time_zone: update schedule metadata.
  • availability: replaces ALL weekly recurring rules (pass every active day).
  • overrides: replaces ALL date-specific overrides.
  • is_default: when True, sets this as the caller’s default schedule.

Authorizations

Parameters

Path Parameters

schedule_id
required

Schedule integer ID.

integer
>= 1

Schedule integer ID.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
availability
Any of:
Array<object>
object
days
required
Array<integer>
end_time
required
string
start_time
required
string
is_default
Any of:
boolean
name
Any of:
string
overrides
Any of:
Array<object>
object
date
required
string
end_time
required
string
start_time
required
string
time_zone
Any of:
string

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string