Guest REST API v2 (legacy)

Update a guest (legacy)

Important

A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.

POST /v2/guests/<guestRef>

Updates the guest.

Attribute	Type	Description	Example
`guestRef`	string	The reference of the guest record. If you do not know the guest reference, first retrieve guests.	`f7aabbca-1c1b-4fc2-be72-3e16294a4f03`

Attribute

Type

Description

Example

guestRef

string

The reference of the guest record.

If you do not know the guest reference, first retrieve guests.

f7aabbca-1c1b-4fc2-be72-3e16294a4f03

Update a guest using Personally Identifiable Information (PII):

curl -X POST '<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
{
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "passportExpiry": "2033-01-01T00:00Z",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "state": "Dublin",
}'

Update a guest using identifiers:

curl -X POST '<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03' \
-u '<username>:<password>' \
-H 'Accept: application/json' \
--data-raw '
{
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}'

201 Created response with Personally Identifiable Information (PII):

{
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2025-03-07T16:15:11.000Z",
   "modifiedAt":"2025-08-23T16:17:16.000Z",
   "firstSeen":"2025-03-07T16:15:11.000Z",
   "lastSeen":"2025-08-23T16:17:16.000Z",
    "guestType": "customer",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "female",
    "dateOfBirth": "1976-10-28T00:00:00.000Z",
    "emails": [
        "[email protected]"
    ],
    "phoneNumbers": [
        "0851234567"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "street": [
        "Apartment 15",
        "West Drive Avenue"
    ],
    "city": "Dublin",
    "country": "Ireland",
    "postCode": "D2",
    "state": "Dublin",
}

201 Created response with identifiers:

{
   "href":"<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "ref":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
   "createdAt":"2025-03-07T16:15:11.000Z",
   "modifiedAt":"2025-08-23T16:17:16.000Z",
   "firstSeen":"2025-03-07T16:15:11.000Z",
   "lastSeen":"2025-08-23T16:17:16.000Z",
   "guestType":"customer",
   "identifiers":[
      {
         "provider":"BXLP",
         "id":"123456",
         "expiryDate":"2028-08-23T16:17:16.000Z"
      }
   ]
}

If you have suggestions for improving this article, let us know!