Skip to main content
PUT
Update Appointment Definition

Path Parameters

appointmentDefinition
integer
required

The appointment definition ID

Body

application/json
booking_questionnaire
object
required
handle
string
Maximum string length: 255
name
string
Maximum string length: 255
description
string | null
short_description
string | null
long_description
string | null
icon
string<uri> | null
image_url
string<uri> | null
terms_conditions
string | null
internal_notes
string | null
visibility_condition
string[] | null
is_published
boolean
is_archived
boolean
duration_minutes
integer
Required range: x >= 1
buffer_before_minutes
integer
Required range: x >= 0
buffer_after_minutes
integer
Required range: x >= 0
min_lead_minutes
integer
Required range: x >= 0
max_advance_days
integer | null
Required range: x >= 1
slot_interval_minutes
integer | null
Required range: x >= 1
booking_type
enum<string>
Available options:
instant,
approval_required,
walk_in_only
allow_customer_booking
boolean
allow_walk_in
boolean
requires_staff
boolean
customer_must_select_staff
boolean
use_staff_from_location
boolean
max_concurrent_bookings
integer | null
Required range: x >= 1
allow_waitlist
boolean
allow_queue
boolean
meta
string[] | null
created_target_id
integer | null
confirmed_target_id
integer | null
cancelled_target_id
integer | null
rejected_target_id
integer | null
reminder_target_id
integer | null
completed_target_id
integer | null
notify_created_offset_days
integer | null
Required range: x >= 0
notify_created_offset_hours
integer | null
Required range: x >= 0
notify_confirmed_offset_days
integer | null
Required range: x >= 0
notify_confirmed_offset_hours
integer | null
Required range: x >= 0
notify_cancelled_offset_days
integer | null
Required range: x >= 0
notify_cancelled_offset_hours
integer | null
Required range: x >= 0
notify_rejected_offset_days
integer | null
Required range: x >= 0
notify_rejected_offset_hours
integer | null
Required range: x >= 0
notify_reminder_offset_days
integer | null
Required range: x >= 0
notify_reminder_offset_hours
integer | null
Required range: x >= 0
notify_completed_offset_days
integer | null
Required range: x >= 0
notify_completed_offset_hours
integer | null
Required range: x >= 0
location_ids
integer[]
staff_ids
string[]
normal_hours
object[]
special_hours
object[]

Response

AppointmentDefinition

data
AppointmentDefinition · object
required