Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

numberOfPeople (optional)

integer

Amount of people ticket is attached to

booking (optional)

object

Time slot configuration, start and end booking time based on one of available time slots retrieved from time slots endpoint

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"]
}'

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"]
}

  • No labels