...
This endpoint allows you to update details of an existing reservation or position (ticket), including notifications, customer information, and other associated data.
Body Parameters
Parameter | Type | Description |
|---|---|---|
notification | object | Optional. Notification configuration, consisting of fields for type and settings. |
customerInfo | string array | Optional. Customer information to attach to the ticket, usually includes first and last name. |
tags | Tag array | Some tags to attach to the ticket, which may contain information about user membership status or payment method. |
numberOfPeople | integer | Optional. The amount of people the ticket is attached to. |
booking | object | Optional. Consists of start and end times for a selected timeslot, and other booking details. See Booking Object Structure below. |
customData | object | Optional. A generic object that can be used to store any relevant ticket information for internal purposes. |
Notification Structure
Field | Type | Description |
|---|---|---|
type | string | Notification type, e.g., "phoneNumber" or "email". |
settings | object | Settings for the notification, including recipient details. |
Booking Object Structure
Field | Type | Description |
|---|---|---|
start | string | Selected timeslot start date in ISO string format. |
end | string | Selected timeslot end date in ISO string format. |
virtualAppointment | boolean | Optional. Indicates whether this reservation is for a remote appointment. |
isEnabled | boolean | True if this reservation is for a remote appointment. |
Tag Structure
Field | Type | Description |
|---|---|---|
id | guid | Unique identifier for the tag. |
iconUrl | string | Optional. URL for the tag's icon. |
color | string | Optional. Color of the tag. |
title | object | Titles with keys representing language codes and string values. |
Authentication
ApiKey header (organizational key) is required.
...