Update an existing reservation or position (ticket).
Body parameters:
Name | Type | Description |
---|---|---|
notification (optional) | object | Notification configuration, consists of fields:
|
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:
|
customData (optional) | object | Generic object that can be used to store any relevant ticket information for internal purposes. |
Tag
{ id: guid iconUrl: string, optional color: string, optional title: { [string]: string } }
Auth:
ApiKey header (organisational key)
Request:
curl --location --request PATCH 'http://localhost:7071/api/organizations/{organizationId}/queues/{queueId}/positions/{positionId}' \ --header 'ApiKey: XYZ' \ --header 'Content-Type: application/json' \ --data-raw '{ "notification": { "type": "phoneNumber", "settings": { "from": "", "to": "+4800000" } }, "customerInfo": ["John", "Doe"], "customData": { "internalIdOrAnyOtherField": "foo", } }'
Response:
{ "id": "9f0c03aa-d7eb-4897-b9fe-4b879bbd943e", "location": null, "type": "booking", "priority": 100, "createdAt": "2020-12-18T11:22:40.034Z", "notification": { "type": "phoneNumber", "settings": { "from": "", "to": "+4800000" } }, "locale": "en", "booking": { "start": "2020-12-07T15:55:00Z", "end": "2020-12-07T16:55:00Z" }, "status": "draft", "label": "", "queue": "b23bea4f-8e8a-4da6-b413-04454f8428aa", "bookingReminderAt": null, "customerInfo": ["John", "Doe"], "customData": { "internalIdOrAnyOtherField": "foo", } }