Update business setup with version and replay protection

Changed on
patch/api/v1/business

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/business
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Request body

namestring
descriptionstring
contact_emailstring
phonestring
timezonestring
brand_colourstring
deposit_percentinteger
hold_minutesinteger
min_notice_minutesinteger
max_advance_daysinteger
customer_cancel_cutoff_hoursinteger
slot_step_minutesinteger
booking_page'open' | 'paused' | 'hidden'
booking_page_messagestring nullable
expected_versioninteger required
idempotency_keystring required
calendar_start_minuteinteger nullable
calendar_end_minuteinteger nullable
require_client_phoneboolean
calendar_colour_by'staff' | 'treatment'

Calendar appointment colours: by team member or by the service collection

industry'beauty_salon' | 'hair_salon' | 'barber' | 'nail_salon' | 'lash_and_brow' | 'aesthetics_clinic' | 'day_spa' | 'massage' | 'medical_clinic' | 'dentist' | 'physiotherapy' | 'gym' | 'fitness_studio' | 'tattoo' | 'veterinary' | 'trades' | 'other' | 'null' nullable

Kind of business, used for the booking page structured data type

theme'aesthetics' | 'dental' | 'physio' | 'vets' | 'clinic' | 'beauty' | 'hair' | 'trades' | 'null' nullable

Niche theme for the booking pages and workspace; null is the Classic look

mascot'swan' | 'otter' | 'hare' | 'cat' | 'pup' | 'owl' | 'fox' | 'poodle' | 'robin' | 'null' nullable

Workspace mascot; null switches it off

mascot_on_bookingboolean

The mascot peeks once on the client booking confirmation

card_charge_max_minorinteger nullable

Owner only: the most a saved card may be charged at once, in pence; null switches card charges off

card_save_at_checkoutboolean

Offer clients a tick box to save their card when paying a deposit online

staff_booking_depositboolean

Bookings made by the team take the deposit (true, the default) or are confirmed with payment in the salon (false)

Response

OK

object required

Changes