Skip to content

Understand updates and disabling

Read this page before you send a PATCH or an enable or disable action. It lists the side effects that affect integrations.

Read the operation's documented side effects before sending a PATCH or action request. The following effects are especially relevant to integrations.

Operation Effect to account for
PATCH a class's service_id or teacher_id Clears the substitute teacher unless substitute_teacher_id is also supplied.
PATCH a class's time, duration or venue Can recreate a published class on an external aggregator; existing aggregator bookings may not be retained.
PATCH a venue For a venue historically associated with several companies, all associated companies observe the update.
Disable a discount code (coupon) Permanently archives it and retires its codes; there is no enable operation.
Disable a base product Also disables its enabled variants. Enable the base before enabling a variant.
Enable or disable a client class pass Omit should_spread_to_shared_passes or use false; true is rejected with 400.
Disable a client appointment pass Also disables synchronized copies; it does not refund the purchase.

For class-pass time restrictions, off_peak_schedule maps ISO weekday numbers as strings ("1" for Monday through "7" for Sunday) to arrays of start/end times in the company timezone. For example, {"1":[["09:00","12:00"]]} specifies a Monday interval. An empty object means no off-peak restriction. Do not treat this field as a complete booking-eligibility check: credits, pass validity, service restrictions and booking windows also apply.