Create a location

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Location Limits
There is a default max # of 400 locations allowed per account. This default can be overridden on an account basis but must be done so by Waitwhile (approved requests for Enterprise plans only).

Query Params

copyLocationId

string

Identifier of location

includeUsers

boolean

Boolean flag

includeResources

enum

Defaults to ASSIGN

Copy option for location fields

includeServices

enum

Defaults to ASSIGN

Copy option for location fields

includeDataFields

enum

Defaults to ASSIGN

Copy option for location fields

includeLabels

boolean

Boolean flag

makeDefault

boolean

Boolean flag

Body Params

address

object | null

allowEstWaitToExceedHours

boolean

Allow estimated wait to exceed location hours, if false estimated wait will be set to N/A when outside of hours

assignedPlugins

array of objects | null

assignedPlugins

bookingAllowOverbooking

boolean

Flag to indicate if logged-in users are allowed to overbook slots

bookingHours

object | null

Hours by day of week

bookingHoursByDate

object | null

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

bookingRejectUnknownCustomers

boolean

Flag to indicate if only existing customers may schedule a booking

bookingSlotColor

string | null

enum

Allowed:

bookingWaitlistOrder

string

enum

Allowed:

businessName

string

length between 1 and 100

Name of company or organization

businessType

string

enum

Type of business or organization (DEPRECATED)

coordinates

object

currency

string | null

Currency in ISO 4217 format

customerSearchMethod

string

enum

Allowed:

customerSessionOverlapMode

string

enum

Allowed:

defaultNumServers

integer | null

1 to 1000

Default number of servers

defaultVisitOrderValue

number | null

≥ 0

Default order value per served visit

defaultServeDuration

integer | null

≥ 0

Default serve duration for serving one visit

displayName

string | null

Display name used in customer facing pages

string | null

Email address

emailReplyToAddress

string

length ≤ 100

Email reply-to address, in addition to default reply-to

enableResourceAutoAway

boolean

Automatically set all location resources as away at midnight (per location timezone)

expiryRules

object | null

Rules for auto completing and expiring visits

externalCustomerIdValidation

string | null

Optional regular expression validation of external customer id

goals

array of objects

Goals

goals

addGoals

array of objects

Goals

addGoals

removeGoals

array of objects

Goals

removeGoals

hours

object | null

Hours by day of week

hoursByDate

object | null

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

i18n

object | null

Location localizations

isActive

boolean

Flag to indicate if active

isForceClosed

boolean

Flag to indicate if waitlist is closed overriding other settings

isForceOpen

boolean

Flag to indicate if waitlist is open overriding other settings

isGoogleWaitlist

boolean

Flag to indicate if available on RwG

isMaxCapacityActive

boolean

Flag to indicate if capacity management is enabled

isPublicBooking

boolean

Flag to indicate if booking check-in is open to public

isPublicCheckIn

boolean

Flag to indicate if waitlist check-in is open to public

isPublicIndexed

boolean

Flag to indicate if location is indexable by search engines

isPublicSearch

boolean

Flag to indicate if location is searchable

isPublicWaitlist

boolean

Flag to indicate if waitlist is open to public

logoUrl

string | null

URL to logo image

publicLogoUrl

string | null

URL to public-facing location logo

labels

array of objects

length ≤ 10

Labels

labels

addLabels

array of objects

length ≤ 10

Labels

addLabels

removeLabels

array of objects

length ≤ 10

Labels

removeLabels

maxPartySize

integer | null

1 to 1000

Max party size

maxPartySizeBookings

integer | null

1 to 1000

Max party size for bookings

maxServing

integer

≥ 0

Max number of parties allowed in SERVING state

maxServingActive

boolean

Flag to indicate if max serving is enforced

maxWaiting

integer

≥ 0

Max number of parties allowed in WAITING state

maxWaitingActive

boolean

Flag to indicate if max waiting is enforced

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.

openWaitlistOnlyAtMaxCapacity

boolean

Flag to indicate if waitlist should only be opened at max capacity

phone

string | null

Phone number in E.164 format

publicLocales

array of objects

length between 1 and 50

Locales available to choose from on public pages

publicLocales

Locale in xx-YY format, where the first part is language and second country code

publicTheme

object | null

Custom theme values used by public pages

recaptchaIpAllowlist

array of strings | null

IP addresses or CIDRs that are allowed to bypass recaptcha checks in public check-in

recaptchaIpAllowlist

recaptchaMinScore

number | null

-1 to 1

Required recaptcha score in public check-in, set to -1 to disable recaptcha check

replyTriggers

array of objects | null

Reply triggers for incoming messages

replyTriggers

resourceCategoryDisplay

string | null

enum

Allowed:

resourceCategoryOpenState

string

enum

Allowed:

resourceItemLayout

string

enum

Allowed:

savedReplies

array of objects | null

Saved message reply templates

savedReplies

serviceCategoryDisplay

string | null

enum

Allowed:

serviceCategoryOpenState

string

enum

Allowed:

serviceItemLayout

string

enum

Allowed:

showEmailQrCode

boolean

Show QR code in visit email messages

signUpTriggers

array of objects | null

signUpTriggers

smsSignupAction

string

enum

Allowed:

theme

string | null

enum

Preset theme for public pages

ticketPrefix

string

length between 0 and 100

Short string

ticketPrefixMode

string

enum

Allowed:

timezone

string

enum

Timezone in IANA continent/city format

visitLockDisabled

boolean

Flag to indicate if location lock is disabled when creating or updating visits

visitQrCodeAction

string

enum

Action URL to encode in QR code

Allowed:

visitRules

array of objects

length ≤ 10

Visit update rules

visitRules

visitTagRules

array of objects | null

Rules for automatically add tags to visits, like prioritized

visitTagRules

waitlistHours

object | null

Hours by day of week

waitlistHoursByDate

object | null

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

waitlistRejectUnknownCustomers

boolean

Flag to indicate if only existing customers may add themselves to waitlists

website

string | null

Public website

customStyleUrl

string | null

URL with http or https protocol

externalId

string

length between 0 and 100

An optional property to use for storing an ID for the location that is manages by some external system

publicStyleUrl

string | null

Custom app stylesheet URL

shortName

string

length ≤ 30

Short name for use in URLs

name

string

required

length between 1 and 100

Name

Location Limits

201Created