Create or update one or more visits

post https://api.waitwhile.com/v2/visits

Though typically used for creating a single visit, this endpoint can also be used to create or update multiple visits by providing an array of separate visit objects. When bulk updating existing visits, each visit object within the array will need to include its respective visit ID as id.

Check out the Create Visits Guide for additional detailed information and request examples.

Responses

Response body

object

string

Identifier of visit

locationId

string

Identifier of location

type

string

Visit type

WAITLIST BOOKING BLOCK

customerId

string

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

externalId

string | null

External identifier, optionally provided by client

externalCustomerId

string | null

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

name

string | null

Name of customer

firstName

string | null

First name of customer

lastName

string | null

Last name of customer

phone

string | null

Phone number in E.164 format

string | null

Email address

messagingTokens

array of objects

length ≤ 5

Tokens used for sending visit messages

messagingTokens

object

type

string

required

FCM

token

string

required

length between 1 and 2000

FCM token or similar

liveActivityToken

object

Update token for customer live activity

fcmToken

string

length between 1 and 2000

FCM token or similar

apnsToken

string

length between 1 and 2000

FCM token or similar

notes

string | null

Optional notes - Deprecated please use notes on customer/notes

serviceIds

array of strings | null

Service identifiers

serviceIds

resourceIds

array of strings | null

Resource identifiers

resourceIds

dataFields

array of objects | null

Data-fields

dataFields

object

string

Unique identifier

values

array

length ≤ 20

values

partySize

integer

1 to 100

Party size

quotedWaitDuration

integer

≥ 0

Wait duration estimated by client

position

integer | null

≥ 1

Current position in line

state

string

State of visit

PENDING DRAFT BOOKED WAITING SERVING COMPLETE

tags

date

string

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

duration

integer

0 to 86400

Duration of booking in seconds

isBlock

boolean

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

source

string

Source where visit was created

WEB-APP IOS-APP ANDROID-APP PUBLIC KIOSK QR SMS EMAIL API RWG IMPORT IOS-APP-CLIP

locale

string

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

ar-AE bg-BG ca-ES cs-CZ de-AT de-CH de-DE en-AU en-CA en-GB en-IN en-US es-ES es-MX es-PE es-PR eu-ES fr-CA fr-CH fr-FR hi-IN hr-HR hu-HU it-CH it-IT ja-JP ka-GE ko-KR nb-NO nl-NL pl-PL pt-PT ro-RO ru-RU sv-SE th-TH tr-TR zh-CN

publicId

string

Short identifier to be used in public links

ticket

string

Ticket of visit

originalPosition

integer | null

≥ 1

Original position in line when added to waitlist

created

date-time

Date and time of creation

updated

date-time

Date and time of last update

pendingTime

date-time

Date and time when visit became pending

draftTime

date-time

Date and time when visit became draft

bookingTime

date-time

Date and time when visit was booked

waitlistTime

date-time

Date and time when visit was added to waitlist

serveTime

date-time

Date and time when visit was served

completedTime

date-time

Date and time when visit was completed

cancelTime

date-time

Date and time when visit was cancelled

removedTime

date-time

Date and time when visit was removed

noShowTime

date-time

Date and time when visit was marked as no-show

confirmedTime

date-time

Date and time when visit was confirmed

arrivedTime

date-time

Date and time when visit was marked as arrived

prioritizedTime

date-time

Date and time when visit was prioritized

expiredTime

date-time

Date and time when visit was expired

flaggedTime

date-time

Date and time when visit was flagged

delayedTime

date-time

Date and time when visit was marked as delayed

importedTime

date-time

Date and time when visit was imported

nextInLineTime

date-time

Date and time when latest next-in-line message was sent

nextInLineTriggerTime

date-time

Date and time when visit first met next-in-line criteria

rejectedTime

date-time

Date and time when visit was rejected

alertedTime

date-time

Date and time when visit was first alerted

lastAlertedTime

date-time

Date and time when visit was last alerted

pendingExpireTime

date-time

Date and time when visit will expire

waitDuration

integer

≥ 0

Duration in waiting state before served

serveDuration

integer

≥ 0

Duration in serving state before completed

estWaitDuration

integer | null

≥ 0

Current estimated wait duration

originalEstWaitDuration

integer

≥ 0

Original estimated wait duration

createdBy

string

Identifier of creator

updatedBy

string

Identifier of last updater

isAnonymized

boolean

Flag to indicate if personal information has been anonymized

orderValue

object

The order value assigned to a visit

value

number

≥ 0

Order value

currency

string

length between 3 and 3

Currency in ISO 4217 format

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.

Has additional fields

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Response body

object

statusCode

integer

200 to 599

HTTP status code for response

message

string

Message for response

error

string

Error if response was a 4xx or 5xx

errorCode

string

Error code if response was a 4xx or 5xx

access_blocked account_already_exists_but_belongs_elsewhere account_already_merged account_creation_disallowed_for_domain account_disabled account_does_not_allow_api_keys account_forbidden account_is_missing_stripe_customer account_messaging_provisioned account_must_contain_at_least_one_location account_not_available account_not_configured_to_use_saml account_not_found account_subscription_missing account_not_verified action_requires_reauthentication anonymization_should_not_be_less_than_24hours api_key_access_not_allowed api_key_not_found asset_already_exists asset_not_found asset_list_forbidden asset_create_forbidden asset_update_forbidden asset_delete_forbidden attribute_is_immutable audit_logs_not_enabled auth_persistence_not_enabled auth_user_has_no_valid_provider auth_user_not_found authentication_token_failed authentication_token_failed_provider_missing availability_cannot_contain_session_and_non_session_services backup_files_not_found booking_not_enabled booking_not_public booking_to_waitlist_sync_not_enabled cannot_assign_non_existing_locations cannot_assign_non_existing_shortname cannot_assign_parent_to_category cannot_assign_non_category_parent cannot_change_is_category cannot_copy_location_settings cannot_delete_organization_with_accounts_assigned cannot_deprovision_type cannot_enable_active_booking cannot_enable_active_waitlist cannot_move_account_owner cannot_provision_local_toll_free_number cannot_provision_type cannot_remove_last_owner cannot_resolve_account_for_location cannot_update_non_pending_visit capacity_management_not_enabled card_cvc_incorrect card_declined card_error_occurred card_number_incorrect card_purchase_not_supported email_must_match_auth_provider circular_parentid client_config_not_found custom_alert_texts_not_enabled custom_billing_settings_not_enabled custom_messaging_not_enabled custom_roles_not_enabled custom_styles_not_enabled custom_support_message_not_enabled customer_already_booked customer_already_waitlisted customer_already_waitlisted_1 customer_data_export_not_enabled customer_import_not_enabled customer_maxed_allowed_upcoming_bookings customer_not_allowed customer_not_found customer_visit_not_found data_anonymization_not_enabled date_missing unknown_error default_value_cannot_be_greater_than_max default_value_cannot_be_less_than_min sandbox_mode_not_enabled domain_assignment_forbidden domain_is_not_allowed domains_already_assigned_to_org duration_missing emaiL_already_accepted_to_account email_already_accepted_to_other_account email_already_invited email_already_invited_to_account email_already_invited_to_other_account email_domain_already_associated email_domain_already_in_use email_domain_not_allowed email_domain_not_allowed_for_acocunt email_missing export_not_enabled export_result_too_large failed_to_allocate_link_id failed_to_allocate_shortname field_graph_references_missing_parent field_cannot_be_both_copied_and_assigned field_not_found field_property_not_allowed file_not_found filter_criteria_too_broad goals_not_enabled https_required impersonated_user_not_allowed_auth_token_creation server_implementation_error incoming_messages_disallowed initiate_customer_chat_not_enabled incorrect_product_price insufficient_permissions insufficient_permissions_to_manage_calendar_block insufficient_permissions_to_move_visit insufficient_permissions_to_remove_visit insufficient_permissions_to_reschedule_booking intercom_signature_verification_failed invalid_account invalid_api_key invalid_billing_account invalid_date_range invalid_channel invalid_coupon invalid_default_location_id invalid_message_channel invalid_message_provider invalid_plan invalid_qr_code_action invalid_queries invalid_roles invalid_template invite_cannot_be_resolved_by_user invite_for_user_not_found invite_not_found invite_for_email_not_found invoice_not_found label_update_forbidden labels_not_enabled last_visit_not_found location_too_busy location_does_not_match_visit_location location_forbidden location_id_missing location_inactive location_not_found location_status_not_found location_with_short_name_already_exists_belongs_elsewhere locations_not_found_on_account max_availability_exceeded max_metadata_keys_exceeded max_num_api_keys_exceeded max_num_rows_exceeded max_number_of_active_locations_exceeded max_number_of_report_templates_exceeded max_number_of_visits_exceeded party_size_exceeded max_serving_capacity_exceeded max_serving_exceeded max_visits_per_request_exceeded max_waiting_capacity_exceeded max_waiting_exceeded message_block_not_found message_body_empty message_config_cannot_be_deleted message_config_not_found message_not_found message_template_not_found message_quota_out_of_range message_usage_out_of_range messaging_already_provisioned_using_different_number_setting messaging_already_provisioned_using_different_provider messaging_already_provisioned_using_different_sender messaging_already_provisioned_using_different_toll_free_number_setting method_not_allowed file_content_does_not_match_content_type file_content_disallowed missing_information locationid_missing missing_location_ids_or_shortnames missing_or_invalid_recaptcha state_missing must_be_super_user_to_migrate_to_target_account must_provision_phone_number no_available_numbers_can_be_provisioned no_available_numbers_found no_available_slots no_available_slots_for_duration no_available_spots_for_resource no_available_spots_for_resource_and_service no_available_spots_for_service_with_duration no_available_spots no_card_or_default_payment_registered no_card_registered no_recipients_for_channel no_upcoming_invoice no_waitlists_found_for_v1 non_owner_cannot_assign_owner_role note_not_found only_sso_user_can_be_provisioned operation_not_found org_assignment_forbidden org_not_found override_default_account_forbidden owner_not_found parent_must_be_category performance_reports_not_enabled phone_number_not_found plan_requires_quantity plan_self_service_is_disabled plugin_not_found price_id_not_found provided_location_shortname_prefix_does_not_match provided_locations_do_not_belong_to_one_account provision_messaging_unsupported recaptcha_verification_failed recaptcha_verification_failed_no_token recipient_email_invalid recepient_phone_invalid referring_account_not_found rejected_by_external_plugin report_run_data_unavailable report_run_in_progress report_run_not_found reporting_not_enabled report_template_multiple_accounts_disallowed report_template_forbidden report_template_invalid_relative_range report_template_invalid_default_template_name report_template_missing_required_fields report_template_not_found report_date_range_too_large report_exceeds_max_analytics_historical_days request_limit_exceeded resource_already_connected_to_user resource_category_has_no_resource_supporting_services resource_category_has_no_resources resourceids_contains_invalid_resource resource_must_belong_to_category resource_not_found role_assignment_forbidden role_forbidden sso_provider_not_allowed sso_type_not_enabled sso_not_available_for_provider saml_sso_logout_url_missing search_not_enabled search_unsupported_entity_type service_cannot_have_both_hours_and_sessions service_sessions_must_be_unique service_with_sessions_not_allowed_on_waitlist serviceids_contains_invalid_service service_not_supported_by_resources service_not_supported_by_any_resource short_name_not_available shortened_link_not_found sms_provider_change_not_allowed sms_provider_api_key_required sms_signup_not_enabled source_account_not_found source_location_not_found sso_provider_missing_data start_after_must_be_date start_after_must_be_datetime start_after_must_be_identifier start_after_must_be_integer subscription_does_not_have_plan_item target_location_not_found toll_free_verification_invalid_payload toll_free_verification_not_found too_many_active_locations too_many_concurrent_queries too_many_requests_for_provided_email twilio_signature_verification_failed type_must_match_parent unauthorized unauthorized_to_assign_locations unauthorized_to_edit_note unauthorized_to_unassign_locations unknown_message_trigger uploaded_file_type_not_allowed user_cannot_connect_with_resource_category user_cannot_remove_themself user_connect_with_resource_forbidden user_does_not_belong_to_account user_does_not_belong_to_v1 user_email_domain_not_allowed user_email_exists user_email_not_found user_exists user_forbidden user_insufficient_permissions user_not_found v1_account_not_found v1_account_subscription_not_found v1_users_not_found validation_error visit_booking_not_allowed visit_cancellation_not_allowed visit_data_missing visit_not_booking visit_missing_required_service_categories visit_missing_required_resource_categories visit_must_have_one_service_assigned visit_not_found visit_not_pending visit_quota_out_of_range visit_quota_exceeded visit_rescheduling_not_allowed visit_rule_id_not_unique visit_rule_immediate_rule_cannot_set_state visit_tag_rules_not_enabled visit_usage_out_of_range visit_waitlist_not_allowed visits_must_be_assigned_to_same_location waitlist_closed waitlist_not_enabled waitlist_not_public webhook_feature_disabled webhook_limit_per_account_exceeded webhook_limit_per_location_exceeded webhook_not_found webhook_port_out_of_range webhook_protocol_invalid webhook_url_hostname_not_found webhook_url_invalid webhook_url_not_allowed white_labeling_not_enabled

429

Too Many Requests

Language

Credentials

Header


xxxxxxxxxx
24
1
curl --request POST \
2
     --url https://api.waitwhile.com/v2/visits \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
[
7
  {
8
    "state": "PENDING",
9
    "isBlock": true,
10
    "source": "WEB-APP",
11
    "locale": "ar-AE",
12
    "policyConsent": true,
13
    "messageInfo": {
14
      "lastOutgoing": {
15
        "channel": "EMAIL",
16
        "state": "PENDING"
17
      },
18
      "lastIncoming": {
19
        "channel": "EMAIL"
20
      }
21
    }
22
  }
23
]
24
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

409Conflict