Create a resource

post

https://api.waitwhile.com/v2/resources

Body Params

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

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 RESOURCE

Allowed:

parentId

string

Parent identifier

isCategory

boolean

Flag to indicate if this is a category

isRequired

boolean

Flag to indicate if required

phone

string | null

Phone number in E.164 format

string | null

Email address

location

string | null

Name

url

string | null

URL with http or https protocol

allowSharing

boolean

Boolean flag

isAway

boolean

Flag to indicate if currently away

isAwayFrom

Date and time resource was set away

isAwayTo

Date and time resource is away until

isAwayReason

string | null

Optional message for away status

enableAutoAway

boolean

Automatically set resource as away at midnight (per location timezone)

requireUserActiveOnLocation

boolean

Boolean flag

isMale

boolean

Flag to indicate if male

minServed

integer | null

≥ 1

Minimum served by this resource

maxServed

integer | null

≥ 1

Maximum served by this resource

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

supportedServiceIds

array of strings | null

Identifiers of supported services (not available for a category)

supportedServiceIds

serviceDurationModifier

number

≥ 0.01

Service duration modifier for this resource

firstAvailableDisplay

string | null

enum

Short string

Allowed:

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

addLocationIds

array of strings

Unique identifiers

addLocationIds

removeLocationIds

array of strings

Unique identifiers

removeLocationIds

addSupportedServiceIds

array of strings

Unique identifiers

addSupportedServiceIds

removeSupportedServiceIds

array of strings

Unique identifiers

removeSupportedServiceIds

alias

string | null

Alias (used in SMS signup)

includeInRestrictedMode

boolean

Flag to indicate if this category is included in Restricted Mode. If enabled, resources in Restricted Mode can book and view resources from this category

staffPreSelectionModes

object

How resource is pre-selected for this category in Staff UI

includeInWaitEstimation

boolean

Flag to indicate if this category is included in wait estimation

staffSelectionComponent

string | null

enum

Component type used by staff when selecting a value

Allowed:

userId

string | null

Identifier of user

name

string | null

required

Name

locationIds

array of strings

required

length ≥ 1

Location identifiers

locationIds*

201Created