Update a service

post

https://api.waitwhile.com/v2/services/{serviceId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serviceId

string

required

Identifier of service

Body Params

name

string | null

Name

displayName

string | null

Display name used in customer facing pages

description

photoUrl

string | null

Photo URL

color

string | null

Color code in any valid CSS format

locationIds

array of strings

length ≥ 1

Location identifiers

locationIds

isActiveWaitlist

boolean

Flag to indicate if available for waitlist

isActiveBooking

boolean

Flag to indicate if available for booking

isActive

boolean

Flag to indicate if active

isPublic

boolean

Flag to indicate if available on public check-in (DEPRECATED, use "access" instead)

externalId

string | null

External identifier, optionally provided by client

access

string

enum

Access mode for data-field

Allowed:

order

integer | null

≥ 0

Order in the user interface, null means default order

metadata

object | null

Store metadata about your objects. You can store 20 keys with max length 40. Values can be strings of max length 500.

i18n

object | null

Resource/Service localizations

type

string

enum

Defaults to SERVICE

Allowed:

parentId

string

Parent identifier

isCategory

boolean

Flag to indicate if this is a category

price

number | null

≥ 0

Service price

orderValue

number | null

≥ 0

Order value for the service

currency

string

length between 3 and 3

Currency in ISO 4217 format

duration

integer | null

0 to 86400

Service duration in seconds

slotDuration

integer | null

≥ 0

Duration in seconds

publicSlotDuration

integer | null

≥ 0

Duration in seconds

bufferDuration

integer | null

0 to 86400

Service buffer duration in seconds

bookingSyncDisabled

boolean

Flag to indicate if bookings with this service should not sync to waitlist

allowSharing

boolean

Boolean flag

bookingSpotsPerDay

integer | null

≥ 1

Maximum booking spots per day for this field

minSelection

integer | null

≥ 1

Minimum services required in public checkin for this service

maxSelection

integer | null

≥ 1

Maximum services required in public checkin for this service

hours

object | null

Hours by day of week

hoursByDate

object | null

Open hours by date in YYYYMMDD format, max 180 dates allowed

waitlistHours

object | null

Hours by day of week

waitlistHoursByDate

object | null

Open hours by date in YYYYMMDD format, max 180 dates allowed

bookingHours

object | null

Hours by day of week

bookingHoursByDate

object | null

Open hours by date in YYYYMMDD format

sessions

array of objects | null

sessions

addLocationIds

array of strings

Unique identifiers

addLocationIds

removeLocationIds

array of strings

Unique identifiers

removeLocationIds

alias

string | null

Alias (used in SMS signup)

minBookingLeadDuration

integer

0 to 31536000

Service booking lead time in seconds

maxBookingLeadDuration

integer

0 to 31536000

Service booking lead time in seconds

staffSelectionComponent

string | null

enum

Component type used by staff when selecting a value

Allowed:

200Successful