Guests Personal Space
Introduction
Welcome to the Guests Personal Space API, designed to empower our hotel partners to effectively manage customer loyalty programs utilizing the customer data stored within our CRM system.
Key Concepts
Customer Existence Requirement: Before a customer can be registered for a loyalty program through the API, they must already exist in the CRM. This ensures that all loyalty benefits and communications are accurately linked to an established customer profile.
Customer Registration Criteria: For a customer to be considered existing within the CRM, they must have either a valid reservation at the hotel or be part of one of the hotel’s email lists. This prerequisite helps maintain the integrity of customer data and ensures that only eligible customers are granted loyalty program access.
Registration Process: The process for partners to register a customer begins with obtaining the customer’s consent to join the loyalty program. Upon agreement, the partner will collect the customer’s desired password (with the understanding that it is the partner’s responsibility to ensure the password meets their validation criteria).
Authentication Flow: Once the customer has set their password, the partner will use the API to register the customer by sending the password along with the customer's email. After successful registration, the partner will log in to the API using the customer's email and password. This action will return an authentication token, which the partner can use for subsequent API interactions.
API Interactions: With the authentication token, partners can perform various operations such as retrieving customer information, accessing the list of reservations, and updating customer details.
Detailed documentation of the endpoints, data formats, and authentication procedures can be found in the following sections.
Available in this API:
Account existsUpdate password / Create accountAccount LoginGet Guest InformationUpdate Guest InformationGuest reservationsLast updated