API Reference
Back to Waitwhile ↗︎

Update a visit

post
https://api.waitwhile.com/v2/visits/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of visit

Query Params
boolean

Boolean flag

boolean

Boolean flag

boolean

Optional parameter that overrides the bookingAllowOverbooking setting on the location for this call

string
enum
Defaults to DEFAULT

Toggle between the standard slot duration and the finer-grained duration (5-min) used for bookings with manual start time

Allowed:
boolean

Whether to apply public mode constraints to the request, e.g. max number of customer visits

Body Params
string

Identifier of visit

string

Identifier of location

string

Identifier of customer, automatically derived from visitor contact information if not provided.

string | null

External customer identifier, optionally provided by client. Will take priority over other contact info when deriving customerId

string | null

Name of customer

string | null

First name of customer

string | null

Last name of customer

string | null

Phone number in E.164 format

string | null

Email address

string | null

Optional notes - Deprecated please use notes on customer/notes

services
object | null

Services of visit, deprecated use serviceIds instead

resources
object | null

Resources of visit, deprecated use resourceIds instead

fields
object

Data-fields of visit, deprecated use dataFields instead

string | null

Unique identifier

serviceIds
array of strings | null

Service identifiers

serviceIds
resourceIds
array of strings | null

Resource identifiers

resourceIds
dataFields
array of objects | null

Data-fields

dataFields
integer
1 to 100

Party size

integer
≥ 0

Wait duration estimated by client

integer | null
≥ 1

Current position in line

string
enum

State of visit

Allowed:
tags
array of objects
length ≤ 10

Optional tags associated with visit

tags
string | null

Date and time of booking, must be in YYYY-MM-DDThh:mm format

integer | null
0 to 86400

Duration of booking in seconds

boolean

Flag to indicate if booking visit is used to block out calendar

string
enum

Source where visit was created

string
enum

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

boolean

Flag to indicate if policy and terms has been accepted

messageInfo
object
addTags
array of objects
length ≤ 10

Adds specified tags to existing tags

addTags
removeTags
array of objects
length ≤ 10

Removes specified tags from existing tags

removeTags
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.

orderValue
object

The order value assigned to a visit

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago