Create a data-field

post

https://api.waitwhile.com/v2/data-fields

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

type

string

enum

Defaults to DATA-FIELD

Allowed:

isRequired

boolean

Flag to indicate if required

isRequiredPublic

boolean

Flag to indicate if required in public pages

inputType

string

enum

Input form field type

inputOptions

array of strings | null

Available data-field values

inputOptions

inputOptionsUrl

string | null

URL to fetch available data-field options

isMultiple

boolean

Flag to indicate if multiple choices is allowed

placeholder

string | null

Placeholder to show in input field

showOtherOption

boolean | null

Flag to indicate if other value is allowed

validation

string | null

Optional regular expression validation of input

defaultValue

string | null

Default value for field

isSensitive

boolean

Flag to indicate if data is sensitive

minValue

length between 0 and 100

Min value for field

maxValue

length between 0 and 100

Max value for field

supportedServiceIds

array of strings | null

Identifiers of supported services (not available for a category)

supportedServiceIds

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

i18n

object | null

Data-field localizations

staffSelectionComponent

string | null

enum

Component type used by staff when selecting a value

Allowed:

name

string | null

required

Name

locationIds

array of strings

required

length ≥ 1

Location identifiers

locationIds*

201Created