Digital check-in from the reservation's own link

post/public/lodging/link/check-in

Digital check-in from the reservation's own link: who is coming, when they arrive, that they read the house rules. It is kept for the desk; no identity document is asked for.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:read
Graphql: Mutation.checkInAhead
Sdk: bookings.publicStay.checkIn
Cli: bookings public stay check in
Events: bookings.reservation.precheckin
Publishable: yes

Request bodyapplication/json, required

tokenstringrequired
At most 600 characters.
arrivalTimestring
Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
guestslist of objectrequired
- namestringrequired
  At most 160 characters.
- nationalitystring
  Pattern: ^[A-Za-z]{2}$.
phonestring
Pattern: ^+?[0-9 ()-]{6,20}$.
vehiclePlatestring
At most 20 characters.
notesstring
Default: . At most 1000 characters.
acceptedHouseRulestruerequired

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/public/lodging/link/check-in' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "string",
  "guests": [
    {
      "name": "string"
    }
  ],
  "acceptedHouseRules": true
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown