...
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 which provides a Meta Array with pagination information.
...
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. |
Retrieve Single Form
This call returns a specific form and the form fields associated for the requested.
Fetch a Properties forms as Form Object array.
| Code Block |
|---|
GET v3/forms/:form_id |
Request URL Parameters
| Parameter | Description |
|---|---|
hotel_id |
|
Cannot be null | |
| hotel_id integer required | Form Numerical identifier from the Retrieve All Forms call. |
limit | The maximum number of forms to return, up to 50. |
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 |
...