PATCH {baseUrl}/queues/{queueId}/positions/{positionId}
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.
Request:
curl --location --request PATCH '{baseUrl}/queues/{queueId}/positions/{positionId}' \ --header 'ApiKey: XYZ' \ --header 'Content-Type: application/json' \ --data-raw '{ "notification": { "type": "phoneNumber", "settings": { "from": "", "to": "+4800000" } }, "customerInfo": ["John", "Doe"], "tags": [ { "id": "3143d93f-643c-4e29-92e8-5af7b25b8c38", "iconUrl": "https://media.omborigrid.com/media/5f55d979ce0cbb6d30c92c3e/27f54990-0f11-11ec-85ff-7bd005db4d31", "color": "#987931", "title": { "en": "G" } } ], "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"], "tags": [ { "id": "3143d93f-643c-4e29-92e8-5af7b25b8c38", "iconUrl": "https://media.omborigrid.com/media/5f55d979ce0cbb6d30c92c3e/27f54990-0f11-11ec-85ff-7bd005db4d31", "color": "#987931", "title": { "en": "G" } } ], "customData": { "internalIdOrAnyOtherField": "foo", } }