Page Comparison

Update 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

Name

Parameter	Type	Description
notification

(optional)

object

Optional. Notification configuration,

consists

consisting 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)

for type and settings.
customerInfo	string array	Optional. Customer information to attach to the ticket

to be shown to the staff; usually contains

, usually includes first and last name.
tags	Tag array	Some tags to attach to the ticket

. May

, which may contain information about user membership status or payment method.

numberOfPeople

(optional)

integer

Amount

Optional. The amount of people the ticket is attached to.

booking

(optional)

object

Optional. Consists of start and end times for a selected timeslot, and other booking details. See 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:

...

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:

Code Block

curl --location --request PATCH 'http://localhost:7071/api/organizations/{organizationId{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",
    }
}'

...

Versions Compared

Old Version 5

New Version 6

Key

Body

Parameters

Notification Structure

Booking Object Structure

Tag Structure

Authentication