Versions Compared

Old Version 3

changes.mady.by.user Kamil Placzek

Saved on

compared with

New Version 4

changes.mady.by.user Dmitry Malofeev (Unlicensed)

Saved on

Key

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

Update an existing reservation or position (ticket).

Body parameters:

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

tags

Tag array

Some tags to attach to the ticket. May contain information about user membership status or payment method.

numberOfPeople (optional)

integer

Amount of people ticket is attached to

booking (optional)

object

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

Tag

Code Block
{
  id: guid
  iconUrl: string, optional
  color: string, optional
  title: { 
    [string]: string
  }
}

Auth:

ApiKey header (organisational key)

...