Reset Key Chain

Reset PIN/SmartKey of a reservation

post
Reset Reservation's Key Chain

[environmentBaseUrl]/v1/reservations/resetKeyChain
This endpoint allows you to reset a reservation's key chain (PIN and SmartKey). Normally you do not need this API as Goki has web/mobile UI for all of the PIN, SmartKey related features, including regenerating them.
Request
Response
Request
Body Parameters
pmsId
required
string
Id of reservation in your system
reset
optional
string
You can choose which part of the key chain you want to regenerate. It accepts a comma-separated string of the following values: (pin | ekey | gatesKeyChain).
Response
200: OK
PIN regenerate is failed. In case you call multiple regenerations (pin,ekey,gatesKeyChain) we try to regenerate them all but also we provide a failures list which is usually an empty list unless one or few of the regeneration options are failed.
{
"data": {
"reservation": {
...ReservationDocument, // Check ReservationDocument page for the sample data
"pin": "4356567"
},
"failures": [
"pin"
]
}
}
404: Not Found
Reservation not found.
{
"error": {
"code": 5,
"title": "NOT_FOUND",
"status": 404,
"message": "Reservation not found!"
}
}
406: Not Acceptable
Reservation is expired.
{
"error": {
"code": 18,
"title": "NOT_ACCEPTABLE",
"status": 406,
"message": "Reservation is expired!",
"reason": "reservationIsExpired"
}
}

Key Chain

For each reservation, we generate access to their rooms in 2 formats:

  1. A PIN which is emailed to the guest

  2. And Ekey (SmartKey) which they receive in their Goki app

Additionally, some properties have SmartLocks installed on the common area doors (lift, kitchen, driveway) and these are referred to as gatesKeyChain.