Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

notification (optional)

object

Notification configuration, consists of fields:

  • type - string value (phoneNumber or email)

  • settings

    • to - for phoneNumber type, customer phone number in E.164 format

    • recipient: for email type notifications

customerInfo (optional)

string array

Customer information to attach to the ticket to be shown to the staff; usually contains first and last name

numberOfPeople (optional)

integer

Amount of people ticket is attached to

booking (optional)

objectTime slot configuration, start and end booking time based on one of available time slots retrieved from time slots

endpointBooking object consists of:

  • start - selected timeslot start date ISO string

  • end - selected timeslot end date ISO string

  • virtualAppointment (optional) - indication whether this reservation is remote appointment

    • isEnabled - true if this is remote appointment

customData (optional)

object

Generic object that can be used to store any relevant ticket information for internal purposes.

...