...
- Create a Request
- Manage a Request
- Receive Request Information
- Receive Staff Information
- Receive Form Information
- Receive Category Information
Terminology
The following terms are used throughout API documentation:
...
To assist our partners' integration to our API platform, please use our support system at our Online Support Portal.
Endpoints
...
Forms
Retrieve All Forms
This call returns all of a properties forms and the fields associated with each form. Forms are returned in a paginated collection. Refer to the Meta array in the object for pagination navigation
Fetch a Properties forms as Form Object array.
Code Block |
---|
GET v3/forms |
Request URL Parameters
Parameter | Description |
---|---|
hotel_id | Property Numerical identifier Cannot be null |
limit | The maximum number of forms to return, up to 50. |
room
string
required
Cannot be null
booking_id
string
required
Cannot be null
details
string
required
email
string
required
an existing guest or create a new guest in MyGuests
name
string
required
phone
string
required
to support eventual SMS functionality
rewards_number
string
optional
Optional field for supporting a hotels rewards or loyalty program. Can be sent as null or omitted if not used.
string
optional
Used when created a Request related to a messaging API.
Optional field which can be sent as null or omitted if not used.
String should match the name of the related OTA Channel i.e. "BookingCenter" or "Booking.com" .
If used message_thread element is required.
string
optional
Optional field which can be sent as null or omitted if not used.
String should match the thread id provided by the OTA for the messaging thread.
If used `message_channel` element is required.
guest_notify
boolean
required
creation. Accepted values false or true
form_name
string
required
and category in MyGuests. If not found a new form will be created
Staff
Parameter | Description |
---|---|
room | Room number assigned to the booking without the siteid. Cannot be null |
booking_id | Primary Booking ID for the request, omitting the siteid. Cannot be null |
details | Details of the request. 2000 characters maximum. |
email | Guest Email . This is the primary key that will be used to match an existing guest or create a new guest in MyGuests |
name | Guest Name |
phone | Guest Primary Phone. Recommended to default to mobile number to support eventual SMS functionality |
rewards_number | Optional field for supporting a hotels rewards or loyalty program. Can be sent as null or omitted if not used. |
message_channel string optional | Used when created a Request related to a messaging API. |
message_thread string optional | Used when created a Request related to a messaging API. Optional field which can be sent as null or omitted if not used. String should match the thread id provided by the OTA for the messaging thread. If used `message_channel` element is required. |
guest_notify | Boolean to determine if we send an email to the guest on new request creation. Accepted values false or true |
form_name | One of "Self Checkin" , "E-Sign" case insensitive. Mappedto form name and category in MyGuests. If not found a new form will be created |
Message Structure
Create Request
...