Save what the property knows about a guest (found by email or phone)

put/lodging/guests

Save what the property knows about a guest (found by email or phone): bed, floor, quiet, diet, accessibility, arrival time, notes. No identity documents are kept.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:write
Sdk: bookings.guest.save
Cli: bookings guest save

Request bodyapplication/json, required

emailstring (email)
At most 254 characters.
phonestring
Pattern: ^+?[0-9 ()-]{6,20}$.
namestringrequired
At most 160 characters.
nationalitystring or null
languagestring or null
preferencesobject
Default: {}.
- bedstring
  At most 60 characters.
- floorstring
  One of: low, high, any.
- quietboolean
- dietlist of string
- accessibilitylist of string
- arrivalTimestring
  Pattern: ^([01]\d|2[0-3]):[0-5]\d$.
notesstring
Default: . At most 2000 characters.

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 PUT 'https://api.rivier.ai/lodging/guests' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

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

This page as Markdown